Skip to content

fix(Select): update incorrect documentation #1825

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 1 commit into from
Jan 10, 2024
Merged

Conversation

booc0mtaco
Copy link
Contributor

Summary:

  • add in proper description for generated form fields based on key/value info
  • hide a field from the documentation table that is currently non-fuctional

Test Plan:

  • Wrote automated tests
  • CI tests / new tests are not applicable
  • Manually tested my changes, but I want to keep the details secret
  • Manually tested my changes, and here are the details:
    • Create an alpha publish and try out in edu-stack or traject as a sanity check if changes affect build or deploy, or are breaking, such as token changes, widely used component updates, hooks changes, and major dependency upgrades.

@booc0mtaco booc0mtaco requested a review from a team January 9, 2024 18:04
Copy link

codecov bot commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (defc30f) 92.50% compared to head (3e7a7d3) 92.50%.
Report is 1 commits behind head on next.

❗ Current head 3e7a7d3 differs from pull request most recent head 77fb2ce. Consider uploading reports for the commit 77fb2ce to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1825   +/-   ##
=======================================
  Coverage   92.50%   92.50%           
=======================================
  Files         147      147           
  Lines        2760     2760           
  Branches      739      739           
=======================================
  Hits         2553     2553           
  Misses        191      191           
  Partials       16       16           

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

Copy link

github-actions bot commented Jan 9, 2024

size-limit report 📦

Path Size
components 97.67 KB (0%)
styles 39.74 KB (0%)

Comment on lines 16 to 42
argTypes: {
multiple: {
table: {
disable: null,
},
},
},
Copy link

Choose a reason for hiding this comment

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

Was this breaking the storybook from rendering? Or just disabling because that arg doesn't work well with storybook UI?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hiding this one b/c we will have a forthcoming component for handling multiple selection and didn't want to have this lingering prop visible. More work to do, but closing a documentation mismatch for the moment.

@booc0mtaco
Copy link
Contributor Author

I'll try to coerce storybook into showing a better type table so that one can see the types for defaultValue and value. Some additional feedback:

  • we might export sub-types for any dependent components so they can be viewed/extended properly (this would apply to other components that have subcomponents with expected types so worth thinking about)

- update the types listed for value and defaultValue
- add in proper description for generated form fields based on key/value info
- hide a field from the documentation table that is currently non-fuctional
@booc0mtaco
Copy link
Contributor Author

Screenshot 2024-01-09 at 18 32 28
Screenshot 2024-01-09 at 18 32 39
Screenshot 2024-01-09 at 18 32 48

@booc0mtaco booc0mtaco merged commit 94aace5 into next Jan 10, 2024
@booc0mtaco booc0mtaco deleted the aholloway/EFI-1515 branch January 10, 2024 00:40
@booc0mtaco booc0mtaco mentioned this pull request Jan 19, 2024
booc0mtaco added a commit that referenced this pull request Jan 19, 2024
## [13.9.0](v13.8.1...v13.9.0) (2024-01-19)

[Storybook](https://61313967cde49b003ae2a860-utfzotmwuw.chromatic.com/)

### Features

* **Avatar:** adjust typography usages and sizing for icons ([#1830](#1830)) ([7da31e6](7da31e6))
* **InlineNotification:** remove deprecated variants ([#1833](#1833)) ([cfcf1fa](cfcf1fa))
* **Label:** mark optional as deprecated ([#1832](#1832)) ([8067082](8067082))
* **tokens:** output token literal values in a new tailwind config file ([#1828](#1828)) ([08fa1c4](08fa1c4))


### Bug Fixes

* **InputField:** mark unused prop as deprecated ([#1831](#1831)) ([622abfb](622abfb))
* **Select:** update incorrect documentation ([#1825](#1825)) ([94aace5](94aace5))
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.

1 participant