`@svatah/yam-ui`

The Yam design system: React components on Radix primitives, every one of them named and id'd (REQ-ADE-12)

Source: packages/ui · README: packages/ui/README.md
Not published: built and used inside this repository, and no release puts it on a registry.
Version 0.1.0 · Apache-2.0 · not published

Exports

Export	Kind	Signature
`Alert`	function	`export function Alert(props: AlertProps): React.JSX.Element`	The alert the mockups draw for a failed load or a missing runtime.
`AlertProps`	interface	`export interface AlertProps`
`AskOverlay`	function	`export function AskOverlay(props:`	An action asking for the one thing it declared it needs (TV-06).
`AUTOMATION_ID_FORM`	variable	`AUTOMATION_ID_FORM = ID_FORM`	The id form, exported so the app and the TUI can check their own ids.
`Button`	function	`export function Button(props: ButtonProps): React.JSX.Element`	A button.
`ButtonProps`	interface	`export interface ButtonProps extends Named`
`Checkbox`	function	`export function Checkbox(props: CheckboxProps): React.JSX.Element`	A labelled checkbox.
`Chip`	function	`export function Chip(`	A neutral chip: a fact, not a status. "page: all", "step 5 only".
`Chooser`	function	`export function Chooser(props: SelectProps): React.JSX.Element`	A chooser, on Radix's `Select`.
`Column`	interface	`export interface Column<Row>`
`CommandPalette`	function	`export function CommandPalette(props: PaletteProps): React.JSX.Element`
`ComponentSheet`	function	`export function ComponentSheet(): React.JSX.Element`	The whole sheet: every component, both themes, on one page.
`Field`	function	`export function Field(props: FieldProps): React.JSX.Element`	A labelled text field.
`FieldProps`	interface	`export interface FieldProps extends Named`
`InspectorSection`	function	`export function InspectorSection(`	One section of the right inspector: a heading and its rows.
`Kbd`	function	`export function Kbd(`	A key, drawn the way the mockups draw one. Decorative by default.
`KeyValues`	function	`export function KeyValues(`	The inspector's key–value grid: `Compiles at`, `Target`, `Binding`.
`Log`	function	`export function Log(props:`	A tail that follows, and says when it has stopped following.
`LogLine`	interface	`export interface LogLine`
`ModeStrip`	function	`export function ModeStrip<Mode extends string>(props:`	The mode strip (REQ-ADE-14).
`Named`	interface	`export interface Named`	Everything interactive takes these two, and neither is optional.
`NAMED_COMPONENTS`	variable	`NAMED_COMPONENTS = [`	Every component that takes a `label` and an `id`, by name.
`PaletteProps`	interface	`export interface PaletteProps`
`PaletteRow`	interface	`export interface PaletteRow`	One row of the palette, as the app and `yam ui` both build it.
`PickerOverlay`	function	`export function PickerOverlay(props:`	"Point at it in the application", as a state rather than a mode of the app.
`Pill`	function	`export function Pill(props: PillProps): React.JSX.Element`	A status pill: a word, in a colour, with the colour's glyph if asked.
`PillProps`	interface	`export interface PillProps`
`PORTAL_HOST_ID`	variable	`PORTAL_HOST_ID = "sv-portal-host"`	The id of the element every overlay in the app is portalled into.
`portalHost`	function	`export function portalHost(): HTMLElement \| undefined`
`RailItem`	function	`export function RailItem(props: RailItemProps): React.JSX.Element`	One row of the left rail.
`RailItemProps`	interface	`export interface RailItemProps extends Named`
`requireNamed`	function	`export function requireNamed(component: string, named: Partial<Named>): string`	Throw, in development, when a control has no name or no id.
`SelectOption`	interface	`export interface SelectOption`
`SelectProps`	interface	`export interface SelectProps extends Named`
`Split`	function	`export function Split(props:`	Two panes and a handle between them.
`Table`	function	`export function Table<Row>(props: TableProps<Row>): React.JSX.Element`	A table with a caption that is its accessible name.
`TableProps`	interface	`export interface TableProps<Row> extends Named`
`TabsProps`	interface	`export interface TabsProps extends Named`
`TabStrip`	function	`export function TabStrip(props: TabsProps): React.JSX.Element`	A tab strip, on Radix's `Tabs`: roving focus, arrow keys, the right roles.
`Toast`	function	`export function Toast(props:`	What just happened, over the frame rather than pushing it (TV-A03).
`Tree`	function	`export function Tree(props: TreeProps): React.JSX.Element`	A semantic tree, which is what a snapshot is.
`TreeNode`	interface	`export interface TreeNode`
`TreeProps`	interface	`export interface TreeProps`
`UnnamedControlError`	class	`export class UnnamedControlError extends Error`

Exports​

Exports