BundleSettingsContext

Context for the token bundling mode (Words / Grammar / Morphemes), a client-side view preference persisted to localStorage and sent to the server tokenizer on every request.

Interfaces¶

BundleSettingsContextType¶

Defined in: src/contexts/BundleSettingsContext.tsx:26

BundleSettingsContextType Shape of the bundle-settings context.

Properties¶

Property	Type	Defined in
`mode`	`BundleMode`	src/contexts/BundleSettingsContext.tsx:27
`resetMode`	() => `void`	src/contexts/BundleSettingsContext.tsx:29
`setMode`	(`mode`) => `void`	src/contexts/BundleSettingsContext.tsx:28

Functions¶

BundleSettingsProvider()¶

function BundleSettingsProvider(props): Element;

Defined in: src/contexts/BundleSettingsContext.tsx:40

A provider for the BundleSettingsContext.

Parameters¶

Parameter	Type	Description
`props`	{ `children`: `ReactNode`; }	The props for the component.
`props.children`	`ReactNode`	-

Returns¶

Element

The BundleSettingsProvider component.

useBundleSettings()¶

function useBundleSettings(): BundleSettingsContextType;

Defined in: src/contexts/BundleSettingsContext.tsx:72

A hook for using the BundleSettingsContext.

Returns¶

BundleSettingsContextType

The BundleSettingsContext.