Package Exports
- @brix-ui/types/component
- @brix-ui/types/css
- @brix-ui/types/palette
- @brix-ui/types/typography
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@brix-ui/types) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@brix-ui/types
Runtime and compile time types for Brix UI.
Intended for internal use.
Installation
npm i @brix-ui/types
yarn add @brix-ui/types
Please note that TypeScript is required to use
d.ts
files
Usage
Most of the types here (represented by as const
objects) were created instead of TypeScript's enums
to avoid of their drawbacks. However, they are just plain JavaScript objects, which can be enumerated and
used just like normal objects.
In TypeScript, though, we use them to describe collections of strings (mostly in union types).
Some types, also, have their respective equivalent in the prop-types
package.