MarkedInputProps

Defined in: packages/markput/src/components/MarkedInput.tsx:28

Props for MarkedInput component.

Example

<MarkedInput<ChipProps>
  Mark={Chip}
  options={[{
    markup: '@[__value__]',
    mark: { label: 'Click me' }
  }]}
/>

Extends

• CoreMarkputProps

Type Parameters

Type Parameter	Default type	Description
TMarkProps	MarkProps	Type of props for the global Mark component
TOverlayProps	OverlayProps	Type of props for the global Overlay component

Properties

className?

optional className: string;

Defined in: packages/markput/src/components/MarkedInput.tsx:42

Additional classes

---

defaultValue?

optional defaultValue: string;

Defined in: packages/core/src/shared/types.ts:46

Default value

Inherited from

CoreMarkputProps.defaultValue

---

Mark?

optional Mark: ComponentType<TMarkProps>;

Defined in: packages/markput/src/components/MarkedInput.tsx:32

Global component used for rendering markups (fallback for option.mark.slot)

---

onChange()?

optional onChange: (value) => void;

Defined in: packages/core/src/shared/types.ts:48

Change event handler

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

CoreMarkputProps.onChange

---

options?

optional options: Option<TMarkProps, TOverlayProps>[];

Defined in: packages/markput/src/components/MarkedInput.tsx:40

Configuration options for markups and overlays. Each option can specify its own slot component via mark.slot or overlay.slot. Falls back to global Mark/Overlay components when not specified.

Overrides

CoreMarkputProps.options

---

Overlay?

optional Overlay: ComponentType<TOverlayProps>;

Defined in: packages/markput/src/components/MarkedInput.tsx:34

Global component used for rendering overlays (fallback for option.overlay.slot)

---

readOnly?

optional readOnly: boolean;

Defined in: packages/core/src/shared/types.ts:50

Prevents from changing the value

Inherited from

CoreMarkputProps.readOnly

---

ref?

optional ref: ForwardedRef<MarkedInputHandler>;

Defined in: packages/markput/src/components/MarkedInput.tsx:30

Ref to handler

---

showOverlayOn?

optional showOverlayOn: OverlayTrigger;

Defined in: packages/markput/src/components/MarkedInput.tsx:61

Events that trigger overlay display

Default

'change'

Overrides

CoreMarkputProps.showOverlayOn

---

slotProps?

optional slotProps: SlotProps;

Defined in: packages/markput/src/components/MarkedInput.tsx:56

Props to pass to slot components

Example

slotProps={{ container: { onKeyDown: handler }, span: { className: 'custom' } }}

---

slots?

optional slots: Slots;

Defined in: packages/markput/src/components/MarkedInput.tsx:50

Override internal components using slots

Example

slots={{ container: 'div', span: 'span' }}

---

style?

optional style: CSSProperties;

Defined in: packages/markput/src/components/MarkedInput.tsx:44

Additional style

---

value?

optional value: string;

Defined in: packages/core/src/shared/types.ts:44

Annotated text with markups for mark

Inherited from

CoreMarkputProps.value