docs(b and c components): consistent api description refs #8536
Conversation
This file contains hidden or 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
…into dit13711/7071-update-api-reference-descriptions
DitwanP
added
the
skip visual snapshots
geospatialem
approved these changes
Jan 2, 2024
There was a problem hiding this comment.
Nice! ✨ 🧹 ✨
Have a few considerations for your review below.
For consistency, we should rename any named components, something like:
Specifies the default behavior of the
buttoncomponent.
Could we add some context to the selection mode types, similar to list?
WDYT about adding in context to the name prop, similar to combobox?
packages/calcite-components/src/components/block-section/block-section.tsx
Show resolved
Hide resolved
packages/calcite-components/src/components/color-picker/color-picker.tsx
Outdated
Show resolved
Hide resolved
packages/calcite-components/src/components/color-picker/color-picker.tsx
Outdated
Show resolved
Hide resolved
packages/calcite-components/src/components/color-picker/color-picker.tsx
Outdated
Show resolved
Hide resolved
packages/calcite-components/src/components/combobox/combobox.tsx
Outdated
Show resolved
Hide resolved
geospatialem
approved these changes
Jan 2, 2024
packages/calcite-components/src/components/chip-group/chip-group.tsx
Outdated
Show resolved
Hide resolved
packages/calcite-components/src/components/combobox/combobox.tsx
Outdated
Show resolved
Hide resolved
…into dit13711/7071-update-api-reference-descriptions
benelan
added a commit
that referenced
this pull request
Jan 4, 2024
…-not-internal * origin/main: docs(d, f, g, and h-named components): update api description refs (#8540) docs(b and c components): consistent api description refs (#8536) ci(update-doc): build design tokens to prevent errors (#8542) docs: update component readmes (#8543) ci: consistent formatting across packages (#8534) refactor(list-item): Remove unnecessary code for rendering open caret (#8537) docs(tab-nav, table, tabs, tile-select, tree, value-list): consistent api description refs (#8535) chore: release next feat(list-item): Add dragSelected property and calciteListItemDragHandleChange event (#8524) chore: release next fix(input-date-picker): hard to reproduce numbering-system caching issue (#8518) feat(handle): add selected property and calciteHandleChange event. (#8484) docs(action-bar, action-group, action-pad, alert): consistent api decription refs (#8533)
benelan
added a commit
that referenced
this pull request
Jan 5, 2024
…mber-infinity * origin/main: refactor: remove @ts-ignore needed for Stencil missing in JSX types (#8551) refactor(combobox): remove unused interface (#8552) fix(input-date-picker): ensure range icon toggles open corresponding date-picker (#8554) fix(button): avoid needlessly overwriting title (#8491) docs(d, f, g, and h-named components): update api description refs (#8540) docs(b and c components): consistent api description refs (#8536)
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.
Related Issue: #7071
Summary
Updates doc consistency across b and c-named components defined in the above issue for props, events, methods, and css vars, including:
buttonblockblock-sectioncolor-picker-hex-inputcolor-pickercomboboxcc @geospatialem