Option

Defined in: react/markput/src/types.ts:42

React-specific markup option for defining mark behavior and styling.

Example

const option: Option<ChipProps> = {
  markup: '@[__value__]',
  mark: { slot: Chip, label: 'Click' }
}

Extends

• CoreOption

Type Parameters

Type Parameter	Default type	Description
TMarkProps	MarkProps	Type of props for the mark component
TOverlayProps extends CoreOption["overlay"]	OverlayProps	Type of props for the overlay component

Properties

mark?

optional mark: TMarkProps | (props) => TMarkProps;

Defined in: react/markput/src/types.ts:52

Props for the mark component. Can be a static object or a function that transforms MarkProps.

---

Mark?

optional Mark: ComponentType<TMarkProps>;

Defined in: react/markput/src/types.ts:47

Per-option component for rendering this mark

---

markup?

optional markup: Markup;

Defined in: core/src/shared/types.ts:57

Template string in which the mark is rendered. Must contain placeholders: __value__, __meta__, and/or __slot__

Placeholder types:

• __value__ - main content (plain text, no nesting)
• __meta__ - additional metadata (plain text, no nesting)
• __slot__ - content supporting nested structures

Examples

// Simple value
"@[__value__]"

// Value with metadata
"@[__value__](__meta__)"

// Nested content support
"@[__slot__]"

Inherited from

CoreOption.markup

---

overlay?

optional overlay: TOverlayProps;

Defined in: react/markput/src/types.ts:58

Props for the overlay component.

Overrides

CoreOption.overlay

---

Overlay?

optional Overlay: ComponentType<TOverlayProps>;

Defined in: react/markput/src/types.ts:54

Per-option component for rendering this overlay