Skip to main content

react-components

package @remirror/react-components

function GenIcon()​

A higher order component which creates the Icon component.

Signature:

export declare function GenIcon(tree: IconTree[], viewBox?: string): IconType;

Parameters:

ParameterTypeDescription
treeIconTree[]
viewBoxstring(Optional)

Returns:

IconType

function MentionAtomPopupComponent()​

This component renders the emoji suggestion dropdown for the user.

Signature:

export declare function MentionAtomPopupComponent<Data extends MentionAtomNodeAttributes = MentionAtomNodeAttributes>(props: MentionAtomPopupComponentProps<Data>): JSX.Element;

Parameters:

ParameterTypeDescription
propsMentionAtomPopupComponentProps<Data>

Returns:

JSX.Element

function useTheme()​

Get the theme from the context and convert it to a style object which can be attached to any element.

The theme provided is deeply merged with the parent theme.

Signature:

export declare function useTheme(props?: UseThemeProps): {
    theme: RemirrorThemeType;
    style: CSSProperties;
    className?: string;
};

Parameters:

ParameterTypeDescription
propsUseThemeProps(Optional)

Returns:

{ theme: RemirrorThemeType; style: CSSProperties; className?: string; }

variable BaselineButtonGroup​

Signature:

BaselineButtonGroup: FC<BaselineButtonGroupProps>

variable BasicFormattingButtonGroup​

Signature:

BasicFormattingButtonGroup: FC<BasicFormattingButtonGroupProps>

variable CalloutTypeButtonGroup​

Signature:

CalloutTypeButtonGroup: FC<CalloutTypeButtonGroupProps>

variable CenterAlignButton​

Signature:

CenterAlignButton: FC<CenterAlignButtonProps>

variable CommandButton​

Signature:

CommandButton: FC<CommandButtonProps>

variable CommandButtonGroup​

Signature:

CommandButtonGroup: FC<CommandButtonGroupProps>

variable CommandMenuItem​

Signature:

CommandMenuItem: FC<CommandMenuItemProps>

variable CopyButton​

Signature:

CopyButton: FC<CopyButtonProps>

variable CreateTableButton​

Signature:

CreateTableButton: FC<CreateTableButtonProps>

variable CutButton​

Signature:

CutButton: FC<CutButtonProps>

variable DataTransferButtonGroup​

Signature:

DataTransferButtonGroup: FC<DataTransferButtonGroupProps>

variable DecreaseFontSizeButton​

Signature:

DecreaseFontSizeButton: FC<DecreaseFontSizeButtonProps>

variable DecreaseIndentButton​

Signature:

DecreaseIndentButton: FC<DecreaseIndentButtonProps>

variable DropdownButton​

Signature:

DropdownButton: FC<DropdownButtonProps>

variable EmojiPopupComponent​

This component renders the emoji suggestion dropdown for the user.

Signature:

EmojiPopupComponent: FC

variable FindReplaceComponent​

Signature:

FindReplaceComponent: FC<FindReplaceComponentProps>

variable FloatingToolbar​

Signature:

FloatingToolbar: FC<FloatingToolbarProps>

variable FloatingWrapper​

Signature:

FloatingWrapper: FC<PropsWithChildren<FloatingWrapperProps>>

variable FormattingButtonGroup​

Signature:

FormattingButtonGroup: FC<FormattingButtonGroupProps>

variable HeadingLevelButtonGroup​

Signature:

HeadingLevelButtonGroup: FC<HeadingLevelButtonGroupProps>

variable HistoryButtonGroup​

Signature:

HistoryButtonGroup: FC<HistoryButtonGroupProps>

variable Icon​

Dynamic icons for the remirror codebase..

Signature:

Icon: (props: IconProps) => JSX.Element

variable IconBase​

The base icon as an svg with the icon context available

Signature:

IconBase: (props: IconBaseProps) => JSX.Element

variable IncreaseFontSizeButton​

Signature:

IncreaseFontSizeButton: FC<IncreaseFontSizeButtonProps>

variable IncreaseIndentButton​

Signature:

IncreaseIndentButton: FC<IncreaseIndentButtonProps>

variable IndentationButtonGroup​

Signature:

IndentationButtonGroup: FC<IndentationButtonGroupProps>

variable InsertHorizontalRuleButton​

Signature:

InsertHorizontalRuleButton: FC<InsertHorizontalRuleButtonProps>

variable JustifyAlignButton​

Signature:

JustifyAlignButton: FC<JustifyAlignButtonProps>

variable LeftAlignButton​

Signature:

LeftAlignButton: FC<LeftAlignButtonProps>

variable ListButtonGroup​

Signature:

ListButtonGroup: FC<ListButtonGroupProps>

variable MarkdownToolbar​

Signature:

MarkdownToolbar: FC

variable PasteButton​

Signature:

PasteButton: FC<PasteButtonProps>

variable PositionerPortal​

Render a component into the editors positioner widget using createPortal from react-dom.

Signature:

PositionerPortal: FC<PositionerComponentProps>

variable RedoButton​

Signature:

RedoButton: FC<RedoButtonProps>

variable RightAlignButton​

Signature:

RightAlignButton: FC<RightAlignButtonProps>

variable TextAlignmentButtonGroup​

Signature:

TextAlignmentButtonGroup: FC<TextAlignmentButtonGroupProps>

variable ThemeProvider​

This the ThemeProvider. Wrap your editor with it to customise the theming of content within your editor.

Please be aware that this wraps your component in an extra dom layer.

Signature:

ThemeProvider: (props: ThemeProviderProps) => ReactElement<ThemeProviderProps>

variable ToggleBlockquoteButton​

Signature:

ToggleBlockquoteButton: FC<ToggleBlockquoteButtonProps>

variable ToggleBoldButton​

Signature:

ToggleBoldButton: FC<ToggleBoldButtonProps>

variable ToggleBulletListButton​

Signature:

ToggleBulletListButton: FC<ToggleBulletListButtonProps>

variable ToggleCalloutButton​

Signature:

ToggleCalloutButton: FC<ToggleCalloutButtonProps>

variable ToggleCalloutMenuItem​

Signature:

ToggleCalloutMenuItem: FC<ToggleCalloutMenuItemProps>

variable ToggleCodeBlockButton​

Signature:

ToggleCodeBlockButton: FC<ToggleCodeBlockButtonProps>

variable ToggleCodeButton​

Signature:

ToggleCodeButton: FC<ToggleCodeButtonProps>

variable ToggleColumnsButton​

Signature:

ToggleColumnsButton: FC<ToggleColumnsButtonProps>

variable ToggleHeadingButton​

Signature:

ToggleHeadingButton: FC<ToggleHeadingButtonProps>

variable ToggleHeadingMenuItem​

Signature:

ToggleHeadingMenuItem: FC<ToggleHeadingMenuItemProps>

variable ToggleItalicButton​

Signature:

ToggleItalicButton: FC<ToggleItalicButtonProps>

variable ToggleOrderedListButton​

Signature:

ToggleOrderedListButton: FC<ToggleOrderedListButtonProps>

variable ToggleStrikeButton​

Signature:

ToggleStrikeButton: FC<ToggleStrikeButtonProps>

variable ToggleSubscriptButton​

Signature:

ToggleSubscriptButton: FC<ToggleSubscriptButtonProps>

variable ToggleSuperscriptButton​

Signature:

ToggleSuperscriptButton: FC<ToggleSuperscriptButtonProps>

variable ToggleTaskListButton​

Signature:

ToggleTaskListButton: FC<ToggleTaskListButtonProps>

variable ToggleUnderlineButton​

Signature:

ToggleUnderlineButton: FC<ToggleUnderlineButtonProps>

variable ToggleWhitespaceButton​

Signature:

ToggleWhitespaceButton: FC<ToggleWhitespaceButtonProps>

variable Toolbar​

Signature:

Toolbar: FC<StackProps>

variable UndoButton​

Signature:

UndoButton: FC<UndoButtonProps>

variable VerticalDivider​

Signature:

VerticalDivider: FC<VerticalDividerProps>

variable WysiwygToolbar​

Signature:

WysiwygToolbar: FC

interface BaselineButtonGroupProps​

Signature:

export interface BaselineButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface BasicFormattingButtonGroupProps​

Signature:

export interface BasicFormattingButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface CalloutTypeButtonGroupProps​

Signature:

export interface CalloutTypeButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface CenterAlignButtonProps​

Signature:

export interface CenterAlignButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface CommandButtonGroupProps​

Signature:

export interface CommandButtonGroupProps extends Omit<BoxProps, 'children'>

Extends: Omit<BoxProps, 'children'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property children​

Signature:

children: ReactNode | ReactNode[];

interface CommandButtonProps​

Signature:

export interface CommandButtonProps extends Omit<ToggleButtonProps, 'value' | 'aria-label'>, Omit<UseCommandOptionValuesParams, 'active' | 'attrs'>

Extends: Omit<ToggleButtonProps, 'value' | 'aria-label'>, Omit<UseCommandOptionValuesParams, 'active' | 'attrs'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property "aria-label"​

Signature:

'aria-label'?: string;

property active​

Signature:

active?: UseCommandOptionValuesParams['active'];

property attrs​

Signature:

attrs?: UseCommandOptionValuesParams['attrs'];

property commandName​

Signature:

commandName: string;

property displayShortcut​

Signature:

displayShortcut?: boolean;

property icon​

Signature:

icon?: CoreIcon | JSX.Element;

property label​

Signature:

label?: NonNullable<ReactNode>;

property onSelect​

Signature:

onSelect: () => void;

interface CommandMenuItemProps​

Signature:

export interface CommandMenuItemProps extends MenuItemProps, Omit<UseCommandOptionValuesParams, 'active' | 'attrs'>

Extends: MenuItemProps, Omit<UseCommandOptionValuesParams, 'active' | 'attrs'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property active​

Signature:

active?: UseCommandOptionValuesParams['active'];

property attrs​

Signature:

attrs?: UseCommandOptionValuesParams['attrs'];

property commandName​

Signature:

commandName: string;

property description​

Signature:

description?: NonNullable<ReactNode>;

property displayDescription​

Signature:

displayDescription?: boolean;

property displayShortcut​

Signature:

displayShortcut?: boolean;

property icon​

Signature:

icon?: CoreIcon | JSX.Element | null;

property label​

Signature:

label?: NonNullable<ReactNode>;

property onSelect​

Signature:

onSelect: () => void;

interface CopyButtonProps​

Signature:

export interface CopyButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface CreateTableButtonProps​

Signature:

export interface CreateTableButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface CutButtonProps​

Signature:

export interface CutButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface DataTransferButtonGroupProps​

Signature:

export interface DataTransferButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface DecreaseFontSizeButtonProps​

Signature:

export interface DecreaseFontSizeButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface DecreaseIndentButtonProps​

Signature:

export interface DecreaseIndentButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface DropdownButtonProps​

Signature:

export interface DropdownButtonProps extends Omit<MenuProps, 'open' | 'anchorEl' | 'id'>

Extends: Omit<MenuProps, 'open' | 'anchorEl' | 'id'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property "aria-label"​

Signature:

'aria-label': string;

property icon​

Signature:

icon?: CoreIcon | JSX.Element;

property label​

Signature:

label?: NonNullable<ReactNode>;

interface FindReplaceComponentProps​

Signature:

export interface FindReplaceComponentProps

property onDismiss​

Signature:

onDismiss?: () => void;

interface FloatingToolbarProps​

Signature:

export interface FloatingToolbarProps extends Omit<PopperProps, 'open' | 'anchorEl'>

Extends: Omit<PopperProps, 'open' | 'anchorEl'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property positioner​

Signature:

positioner?: PositionerParam;

interface FormattingButtonGroupProps​

Signature:

export interface FormattingButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface HeadingLevelButtonGroupProps​

Signature:

export interface HeadingLevelButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

property showAll​

Signature:

showAll?: boolean;

interface HistoryButtonGroupProps​

Signature:

export interface HistoryButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface IconBaseProps​

Signature:

export interface IconBaseProps extends SVGAttributes<SVGElement>

Extends: SVGAttributes<SVGElement>

(Some inherited members may not be shown because they are not represented in the documentation.)

property children​

Signature:

children?: ReactNode;

property color​

Signature:

color?: string;

property size​

Signature:

size?: string | number;

property title​

Signature:

title?: string;

interface IconProps​

Signature:

export interface IconProps extends IconBaseProps

Extends: IconBaseProps

(Some inherited members may not be shown because they are not represented in the documentation.)

property children​

Signature:

children?: ReactNode;

property color​

Signature:

color?: string;

property name​

The name of the core icon to use.

Signature:

name: Icons.CoreIcon;

property size​

Signature:

size?: string | number;

property title​

Signature:

title?: string;

interface IncreaseFontSizeButtonProps​

Signature:

export interface IncreaseFontSizeButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface IncreaseIndentButtonProps​

Signature:

export interface IncreaseIndentButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface IndentationButtonGroupProps​

Signature:

export interface IndentationButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface InsertHorizontalRuleButtonProps​

Signature:

export interface InsertHorizontalRuleButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface JustifyAlignButtonProps​

Signature:

export interface JustifyAlignButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface LeftAlignButtonProps​

Signature:

export interface LeftAlignButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ListButtonGroupProps​

Signature:

export interface ListButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

interface PasteButtonProps​

Signature:

export interface PasteButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface PositionerComponentProps​

Signature:

export interface PositionerComponentProps

property children​

Signature:

children: ReactNode;

interface RedoButtonProps​

Signature:

export interface RedoButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface RightAlignButtonProps​

Signature:

export interface RightAlignButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface TextAlignmentButtonGroupProps​

Signature:

export interface TextAlignmentButtonGroupProps

property children​

Signature:

children?: ReactNode | ReactNode[];

property showAll​

Signature:

showAll?: boolean;

interface ThemeProviderProps​

Signature:

export interface ThemeProviderProps extends UseThemeProps

Extends: UseThemeProps

property as​

A custom component to use for the wrapper.

Signature:

as?: ElementType<{
        style?: CSSProperties;
        className?: string;
    }>;

property children​

Signature:

children: ReactNode;

property className​

Any extra class names to add to the wrapper component.

Signature:

className?: string;

property theme​

The theme to customise the look and feel of your remirror editor.

Signature:

theme?: RemirrorThemeType;

interface ToggleBlockquoteButtonProps​

Signature:

export interface ToggleBlockquoteButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleBoldButtonProps​

Signature:

export interface ToggleBoldButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleBulletListButtonProps​

Signature:

export interface ToggleBulletListButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleCalloutButtonProps​

Signature:

export interface ToggleCalloutButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property attrs​

Signature:

attrs?: Partial<CalloutExtensionAttributes>;

interface ToggleCalloutMenuItemProps​

Signature:

export interface ToggleCalloutMenuItemProps extends Omit<CommandMenuItemProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandMenuItemProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property attrs​

Signature:

attrs?: Partial<CalloutExtensionAttributes>;

interface ToggleCodeBlockButtonProps​

Signature:

export interface ToggleCodeBlockButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property attrs​

Signature:

attrs?: Partial<CodeBlockAttributes>;

interface ToggleCodeButtonProps​

Signature:

export interface ToggleCodeButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleColumnsButtonProps​

Signature:

export interface ToggleColumnsButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property attrs​

Signature:

attrs?: Partial<ColumnAttributes>;

interface ToggleHeadingButtonProps​

Signature:

export interface ToggleHeadingButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property attrs​

Signature:

attrs?: Partial<HeadingExtensionAttributes>;

interface ToggleHeadingMenuItemProps​

Signature:

export interface ToggleHeadingMenuItemProps extends Omit<CommandMenuItemProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandMenuItemProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

property attrs​

Signature:

attrs?: Partial<HeadingExtensionAttributes>;

interface ToggleItalicButtonProps​

Signature:

export interface ToggleItalicButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleOrderedListButtonProps​

Signature:

export interface ToggleOrderedListButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleStrikeButtonProps​

Signature:

export interface ToggleStrikeButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleSubscriptButtonProps​

Signature:

export interface ToggleSubscriptButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleSuperscriptButtonProps​

Signature:

export interface ToggleSuperscriptButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleTaskListButtonProps​

Signature:

export interface ToggleTaskListButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleUnderlineButtonProps​

Signature:

export interface ToggleUnderlineButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface ToggleWhitespaceButtonProps​

Signature:

export interface ToggleWhitespaceButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface UndoButtonProps​

Signature:

export interface UndoButtonProps extends Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

Extends: Omit<CommandButtonProps, 'commandName' | 'active' | 'enabled' | 'attrs' | 'onSelect'>

(Some inherited members may not be shown because they are not represented in the documentation.)

interface UseThemeProps​

Signature:

export interface UseThemeProps

property className​

Any extra class names to add to the wrapper component.

Signature:

className?: string;

property theme​

The theme to customise the look and feel of your remirror editor.

Signature:

theme?: RemirrorThemeType;

type IconType​

Signature:

export type IconType = (props: IconBaseProps) => JSX.Element;

References: IconBaseProps

type VerticalDividerProps​

Signature:

export type VerticalDividerProps = Omit<DividerProps, 'orientation'>;