ni / nimble

The NI Nimble Design System
https://nimble.ni.dev
MIT License
29 stars 9 forks source link

Improve API documentation for input components #2132

Closed jattasNI closed 1 month ago

jattasNI commented 1 month ago

Pull Request

🤨 Rationale

Ongoing efforts towards #824. This PR covers input components:

👩‍💻 Implementation

Generally follow patterns from previous PRs like #2126 and #2117. A few interesting notes:

  1. components have different behaviors regarding whether they sync their value property to an attribute. I documented the behavior I observed by adding a new table category for properties that don't have attributes (also used by checkbox indeterminate property).
  2. not yet documenting a recommendation to use form association / CVAs instead of change events and value properties. Until I do so, the placeholder docs for select are outside any table category.
  3. added another new table category for localizable strings.
  4. not yet documenting list option API in the select and combobox stories. We (probably Meyer) are going to tackle this in a follow up after #2111.

🧪 Testing

✅ Checklist

jattasNI commented 1 month ago

@m-akinc would you mind being my buddy for API docs changes while Milan is out of office?

jattasNI commented 1 month ago

Bypassed @rajsite due to OOO.