refactor(pie-docs): DSW-2324 update the tag overview docs #2067
+1,168
−212
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 32ea1ac The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
raoufswe
force-pushed
the
dsw-2324-update-overview-docs
branch
from
0ab86dc
to
99e9dfc
Compare
raoufswe
changed the title
raoufswe
commented
Nov 15, 2024
| } %} | ||
|
|
||
| {% list { | ||
| type: listTypes.ordered, | ||
| items: [ | ||
| "**Icon (Optional):** Visually supports the label.", | ||
| "**Label:** Provides information about the content or purpose of the tag.", | ||
| "**Container**: Background container that organises the information." | ||
| "**Label:** Provides informative information to the user.", |
There was a problem hiding this comment.
I can feel Xander disapproving of this wording across the planet - I think "informative information" might be redundant. Could we remove "informative" please?
Suggested change
| "**Label:** Provides informative information to the user.", | |
| "**Label:** Provides information to the user.", |
| "**Label:** Provides information about the content or purpose of the tag.", | ||
| "**Container**: Background container that organises the information." | ||
| "**Label:** Provides informative information to the user.", | ||
| "**Trailing icon (Optional):** Indicates additional actions or further interactions." |
There was a problem hiding this comment.
Just to check we haven't missed a requirement here - does the trailing icon emit a different event to the leading?
There was a problem hiding this comment.
both leading and trailing icons don't emit any event, they are pure visuals.
|
|
||
| Tag can use colour for visual categorisation. | ||
| The non-interactive variation should be used by default, and should be used when the tag doesn’t require any interactive features tied to the instance. |
There was a problem hiding this comment.
Suggested change
| The non-interactive variation should be used by default, and should be used when the tag doesn’t require any interactive features tied to the instance. | |
| The non-interactive variation should be used by default, and should be used when the tag doesn’t require any interactivity. |
siggerzz
previously approved these changes
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes (can list changeset entries if preferable)
Author Checklist (complete before requesting a review)
Reviewer checklists (complete before approving)
Reviewer 1
Reviewer 2