Skip to content

docs: improve consistency for component prop descriptions #8580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 10, 2024

Conversation

DitwanP
Copy link
Contributor

@DitwanP DitwanP commented Jan 9, 2024

Related Issue: #7071

Summary

Updates doc consistency across various components defined in the above issue for props, events, methods, and css vars, including:

  • block-section
  • checkbox
  • chip
  • combobox
  • fab
  • input-number
  • input-time-zone
  • radio-button
  • segmented-control
  • shell-panel
  • switch
  • text-area
  • tile-select
  • tree

@DitwanP DitwanP requested a review from a team as a code owner January 9, 2024 22:37
@DitwanP DitwanP changed the title Improve prop description consistency across various components. docs(various components): improve consistency in property descriptions Jan 9, 2024
@DitwanP DitwanP added skip visual snapshots Pull requests that do not need visual regression testing. docs Issues relating to documentation updates only. labels Jan 9, 2024
…into dit13711/7071-make-changes-from-verification-feedback
@DitwanP DitwanP changed the title docs(various components): improve consistency in property descriptions docs: improve consistency in property descriptions Jan 9, 2024
@DitwanP DitwanP changed the title docs: improve consistency in property descriptions docs: improve consistency for component prop descriptions Jan 9, 2024
DitwanP and others added 4 commits January 9, 2024 14:53
…iltered items are shown (#8569)

**Related Issue:** #8564

## Summary

- Adds slot `"filter-no-results"`.
- When filter is enabled, a filter text is present and there are no
items being shown, this slot will be displayed
- The slot is for showing any warning information that there are no
items displayed
  - Allows a user to customize any messaging for no results shown.
- Adds screenshot test
- Adds e2e test
@DitwanP DitwanP requested a review from geospatialem January 9, 2024 22:56
…into dit13711/7071-make-changes-from-verification-feedback
Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

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

✨🧹📚✨

Copy link
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 additions! 🥇

Few nitpicks and follow-up questions for consideration.

@DitwanP DitwanP requested a review from geospatialem January 10, 2024 17:57
…into dit13711/7071-make-changes-from-verification-feedback
…into dit13711/7071-make-changes-from-verification-feedback
…into dit13711/7071-make-changes-from-verification-feedback
Copy link
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.

A few more lowercase id refs, and then this LGTM 🚀

@DitwanP DitwanP merged commit fb51835 into main Jan 10, 2024
@DitwanP DitwanP deleted the dit13711/7071-make-changes-from-verification-feedback branch January 10, 2024 23:23
benelan added a commit that referenced this pull request Jan 10, 2024
…ion-message

* origin/main:
  chore: release next
  docs: improve consistency for component prop descriptions (#8580)
benelan added a commit that referenced this pull request Jan 12, 2024
…idation-ui

* origin/main:
  feat(handle, block, list-item): improve drag handle tooltip to include item label (#8584)
  chore: release next
  feat: reflect validationIcon property (#8583)
  chore: release next
  docs: improve consistency for component prop descriptions (#8580)
  test(action-menu): skip close on blur test. (#8585)
  feat(tabs): emit selection-related events when selection is modified after closing the selected tab (#8582)
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.

4 participants