Skip to content

chore: update documentation to refere to DruxtWrapper as DruxtTheme - #358

Open
BrianGilbert wants to merge 1 commit into
developfrom
feature/5-documentation-druxtwrapper
Open

chore: update documentation to refere to DruxtWrapper as DruxtTheme#358
BrianGilbert wants to merge 1 commit into
developfrom
feature/5-documentation-druxtwrapper

Conversation

@BrianGilbert

@BrianGilbert BrianGilbert commented Nov 1, 2021

Copy link
Copy Markdown
Member

Types of changes

  • Documentation

Description

Replaced reference to DruxtWrapper with DruxtTheme

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly. (PR: #)
  • I have added tests to cover my changes (if not applicable, please state why)
  • All new and existing tests are passing.

Screenshots/Media:

@changeset-bot

changeset-bot Bot commented Nov 1, 2021

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: de9418a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov

codecov Bot commented Nov 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #358 (de9418a) into develop (c4457e1) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #358   +/-   ##
========================================
  Coverage    96.70%   96.70%           
========================================
  Files           89       89           
  Lines         2826     2826           
  Branches       604      604           
========================================
  Hits          2733     2733           
  Misses          83       83           
  Partials        10       10           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c4457e1...de9418a. Read the comment docs.

@Decipher Decipher mentioned this pull request Nov 9, 2021
8 tasks
Component options can be seen via the `component.options` data of the relevant Druxt module component.

If there are no matching component names, a default `DruxtWrapper` component will be used to render the default output of the module.
If there are no matching component names, a default `DruxtTheme` component will be used to render the default output of the module.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong, the default component is still a DruxtWrapper component.

@Decipher Decipher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BrianGilbert Still needs work.

While the concept is changing from the name Wrapper component to Theme component, the placeholder component, when no Theme component is rendered, is still called DruxtWrapper.

</DruxtEntity>
```

By default, a component using the default template will not be wrapped by a DruxtWrapper component. It is possible to enable the DruxtWrapper system by setting the `wrapper` property to `true`:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also wrong, the DruxtWrapper is the placeholder component, this hasn't changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants