Skip to content
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

Document the Select component listboxOverflow #1754

Merged
merged 2 commits into from
Oct 29, 2024
Merged

Conversation

acelaya
Copy link
Contributor

@acelaya acelaya commented Oct 28, 2024

The listboxOverflow prop was added in #1746. This PR documents it and adds examples.

listbox-overflow-docs-2024-10-28_14.45.50.mp4

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (903b9ac) to head (3ebacea).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1754   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           67        67           
  Lines         1205      1205           
  Branches       454       454           
=========================================
  Hits          1205      1205           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

<Library.Example title="listboxOverflow">
<Library.Info>
<Library.InfoItem label="description">
Determines the behavior of the listbox options when their
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Determines the behavior of the listbox options when their
Determines the behavior of the listbox options when their

"options" or "items"? The component is called Select.Option but code examples tend to use the term "items" for the data arrays from which the options are generated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I would use "items" when conceptually talking about the entries of the list, and "options" when talking about the markup elements explicitly.

In this case, since we are talking about how they render, I think I would use "options".

But this is not a strong opinion, and I see a lot of grey areas in that reasoning, so I'm ok using a different wording.

Copy link
Member

Choose a reason for hiding this comment

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

I think I would use "items" when conceptually talking about the entries of the list, and "options" when talking about the markup elements explicitly.

That makes sense.

@acelaya acelaya merged commit 7fc3e67 into main Oct 29, 2024
2 checks passed
@acelaya acelaya deleted the listbox-overflow-docs branch October 29, 2024 09:48
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