Skip to content

docs(tokens): consistency pass for new component descriptions#12148

Merged
DitwanP merged 4 commits intodevfrom
dit13711/cleanup-token-descriptions
May 15, 2025
Merged

docs(tokens): consistency pass for new component descriptions#12148
DitwanP merged 4 commits intodevfrom
dit13711/cleanup-token-descriptions

Conversation

@DitwanP
Copy link
Copy Markdown
Contributor

@DitwanP DitwanP commented May 14, 2025

Related Issue: n/a

Summary

Updates token documentation for the following components:

  • input-number
  • shell-panel
  • stepper-item
  • stepper
  • tabs
  • time-picker

@DitwanP DitwanP requested a review from geospatialem May 14, 2025 21:29
@DitwanP DitwanP added the skip visual snapshots Pull requests that do not need visual regression testing. label May 14, 2025
@github-actions github-actions Bot added the docs Issues relating to documentation updates only. label May 14, 2025
Copy link
Copy Markdown
Member

@geospatialem geospatialem left a comment

Choose a reason for hiding this comment

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

Thanks for tackling so quick! 🐇

It looks like a few of the original text sections are in alignment with our doc pattern, can you take a closer look? 👀

Could you also update the PR's summary that describes the change, rather than the action of the PR? Something like "Updates design token documentation to xyz.. components"?

Comment thread packages/calcite-components/src/components/sheet/sheet.scss Outdated
Comment thread packages/calcite-components/src/components/shell-panel/shell-panel.scss Outdated
Comment thread packages/calcite-components/src/components/stepper-item/stepper-item.scss Outdated
Comment thread packages/calcite-components/src/components/tab-nav/tab-nav.scss Outdated
Comment thread packages/calcite-components/src/components/tab-title/tab-title.scss Outdated
Comment thread packages/calcite-components/src/components/tabs/tabs.scss Outdated
@DitwanP DitwanP requested a review from geospatialem May 14, 2025 21:54
Copy link
Copy Markdown
Member

@geospatialem geospatialem left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for the quick turnaround! It looks like one minor change, then LGTM! 🚀

Comment thread packages/calcite-components/src/components/tabs/tabs.scss Outdated
@DitwanP DitwanP merged commit 7d25fe8 into dev May 15, 2025
10 checks passed
@DitwanP DitwanP deleted the dit13711/cleanup-token-descriptions branch May 15, 2025 16:46
benelan added a commit that referenced this pull request May 15, 2025
* origin/dev: (277 commits)
  docs(tokens): consistency pass for new component descriptions (#12148)
  build(preset): use valid TS module resolution (#12151)
  docs: update list of contributors (#12134)
  chore: drop obsolete transforms (#12136)
  chore: release main (#11890) (#12147)
  build(deps): bump @arcgis/lumina, typescript, vite, vitest (#12137)
  chore(preset): fix JSON import in build config (#12142)
  docs(panel, action): update `text-color-pressed` token descriptions (#12140)
  chore: release next
  fix(input-time-picker): invert text color on Windows when each masked input is focused (#12130)
  chore: release next
  refactor(sematic-tokens): update `--calcite-corner-radius-default` to reference correct token (#12131)
  feat(semantic-tokens): add `--calcite-color-text-highlight` tokens (#12068)
  chore: release next
  feat(combobox): add `selectAll` toggle property (#11721)
  chore: release next
  fix(sort-handle): allow move and reorder events to be cancelled (#12095)
  chore: release next
  feat: added spike data, heart chart, and progress bar icons (#12127)
  feat(text-area): Add design tokens for corner radius, shadow, footer background color (#12124)
  ...
* These properties can be overridden using the component's tag as selector.
*
* @prop --calcite-tab-background-color: When `bordered`, specifies the component's background color.
* @prop --calcite-tab-background-color: When `bordered`, specifies the component's background color when `bordered`.
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.

@DitwanP Can you do a follow-up PR to remove the extra "when bordered" at the end of this sentence?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oops! on it.

jcfranco pushed a commit that referenced this pull request May 29, 2025
**Related Issue:** n/a

## Summary
Updates token documentation for the following components:
- `input-number`
- `shell-panel`
- `stepper-item`
- `stepper`
- `tabs`
- `time-picker`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues relating to documentation updates only. skip visual snapshots Pull requests that do not need visual regression testing.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants