npm - @theroutingcompany/components - Versions diffs - 0.0.18-alpha.4 → 0.0.18-alpha.6 - Mend

@theroutingcompany/components 0.0.18-alpha.4 → 0.0.18-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/README.md +10 -0
package/dist/trc-components.es.js +9609 -8259
package/dist/trc-components.es.js.map +1 -1
package/dist/trc-components.umd.js +382 -278
package/dist/trc-components.umd.js.map +1 -1
package/dist/tsconfig.tsbuildinfo +1 -1
package/package.json +7 -6
package/types/components/DropdownMenu/DropdownMenu.d.ts +19 -0
package/types/components/FileUpload/FileUpload.d.ts +2 -2
package/types/components/IconButton/IconButton.d.ts +1 -1
package/types/components/Popover/Popover.d.ts +1 -1
package/types/components/index.d.ts +1 -0
package/types/helpers/interactionStates.d.ts +6 -0

package/README.md CHANGED Viewed

@@ -309,6 +309,16 @@ Two ways we can solve this
 1. Filter spread props. Reject all non-DOM props using a utility. Note react-aria has a util names `filterDOMProps` despite its name it does not filter DOM props (I think it's a legacy util).
 2. Be more explicit. Write out all the props to forward and types explicitly.
+## Configurable Components Should Have Sane Defaults & Not Blow Up Without Props
+> **Warning**
+> This is a principle we don't always abide by but should!
+Every component should have enough default props to render without exploding and look normal.
+- ❌ `<Title>Hi</Title>` without `size` prop raising `Element type is invalid: expected a string (for built-in components) or a class/function (for composite components) but got: undefined`
+- ✅ `<Title>Hi</Hi>` without `size` prop defaults to `size='medium'` and doesn’t blow up.
 ## Examples