` tag
default: `undefined`
- suggestions: input suggestions of normal texts
default: `[]`
- initialSuggestionIndex: index of focusd suggestion when showing the suggestion list
default: `0`
- normalLabel: label name of normal section in Syntax Menu. This is also used as the default section name
default: `normal`
- largerLabel: label name of larger section in Syntax Menu. This is also used as the default section name
default: `larger`
- largestLabel: label name of largest section in Syntax Menu. This is also used as the default section name
default: `largest`
### BracketLinkProps
settings of bracket links
```ts
interface BracketLinkProps {
anchorProps?: (linkName: string, active: boolean) => React.ComponentProps<'a'> | undefined;
suggestions?: string[];
initialSuggestionIndex?: number;
disabled?: boolean;
}
```
**Attributes**
- anchorProps: given `linkName` and `active`, this function returns props of `
` tag
default: `undefined`
- suggestions: input suggestions of bracket links
default: `[]`
- initialSuggestionIndex: index of focusd suggestion when showing the suggestion list
default: `0`
- disabled: if `true`, syntax of bracket links is ignored
default: `undefined` (falsy)
### HashtagProps
settings of hash tags
```ts
interface HashtagProps {
anchorProps?: (hashtagName: string, active: boolean) => React.ComponentProps<'a'> | undefined;
suggestions?: string[];
initialSuggestionIndex?: number;
disabled?: boolean;
}
```
same as `BracketLinkProps`
### TaggedLinkProps
settings of tagged links
```ts
interface TaggedLinkProps {
linkNameRegex?: RegExp;
anchorProps?: (linkName: string, active: boolean) => React.ComponentProps<'a'> | undefined;
suggestions?: string[];
initialSuggestionIndex?: number;
tagHidden?: boolean;
}
```
same as `BracketLinkProps` except `linkNameRegex` and `tagHidden`
`disabled` property doesn't exist since you don't define a tag if you don't need it
**Attributes**
- linkNameRegex: regular expression of link names. This **MUST** be a subset of `defaultLinkNameRegex = /[^[\]]+/`
If `tagged link` does not match the pattern, `[tag: tagged link]` will be a BRACKET LINK whose name is `tag: tagged link`
default: `defaultLinkNameRegex`
- tagHidden: if `true`, `[tag: tagged link]` goes to `tagged link` instead of `
tag: tagged link`
**Default**
```ts
export const defaultLinkNameRegex = /[^[\]]+/;
```
you can import `defaultLinkNameRegex` by adding
```ts
import { defaultLinkNameRegex } from 'react-realtime-markup-editor';
```
### CodeProps
settings of code strings
```ts
interface CodeProps {
codeProps?: (code: string) => React.ComponentProps<'code'> | undefined;
inlineLabel?: string;
blockLabel?: string;
disabled?: boolean;
}
```
**Attributes**
- codeProps: given `code`, this function returns props of `
` tag
default: `undefined`
- inlineLabel: label name of inline code in Syntax Menu. This is also used as the default code value
default: `inline code`
- blockLabel: label name of block code in Syntax Menu. This is also used as the default code value
default: `block code`
- disabled: if `true`, syntax of code strings is ignored
default: `undefined` (falsy)
### FormulaProps
settings of math formulas
```ts
interface FormulaProps {
spanProps?: (formula: string) => React.ComponentProps<'span'> | undefined;
inlineLabel?: string;
displayLabel?: string;
blockLabel?: string;
disabled?: boolean;
}
```
**Attributes**
- spanProps: given `formula`, this function returns props of `` tag
default: `undefined`
- inlineLabel: label name of inline formula in Syntax Menu. This is also used as the default formula value
default: `inline formula`
- displayLabel: label name of display formula in Syntax Menu. This is also used as the default formula value
default: `display formula`
- blockLabel: label name of block formula in Syntax Menu. This is also used as the default formula value
default: `block formula`
- disabled: if `true`, syntax of math formulas is ignored
default: `undefined` (falsy)
---
_Source: https://npm.io/package/react-realtime-markup-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)