Skip to content
Nizivo UI

Config

The @nizivo/react/config entry.

Import

import { NizivoConfig } from '@nizivo/react/config';

Props

Client component Renders no element of its own. Props: NizivoConfigProps. Source: src/config/config.client.tsx.

NameTypeDefaultDescription
childrenReactNode–
labelsNizivoLabels–

Built-in strings for the client parts in this scope. A part's own labels prop wins key by key; a key neither sets falls back to the English default. Keep the object stable (a module constant or memoised), as with any context value.

localestring'en-US'

BCP 47 tag used by engine-backed parts.

Exports

NizivoConfigProps type

import type { NizivoConfigProps } from '@nizivo/react/config'

The props of NizivoConfig, listed above.

NizivoLabels type

import type { NizivoLabels } from '@nizivo/react/config'

Built-in strings for every client part in the scope, shaped like the enUS catalogue (@nizivo/react/locales/en-US): keyed by component, every key and every string optional, so a whole catalogue of another locale fits. Read by the client parts the Strings guide lists; the other keys (server parts such as Pagination, Button and Breadcrumb, which cannot read a context, and AlertDismiss) are ignored here, and those parts take labels per instance.

type NizivoLabels = { [K in keyof typeof enUS]?: Partial<(typeof enUS)[K]>; }

Augment

The @nizivo/react/augment entry.

Contracts

The @nizivo/react/contracts entry.

On this page

ImportPropsExports