extension-react-tables
package @remirror/extension-react-tables
class TableCellExtension
Signature:
export declare class TableCellExtension extends BaseTableCellExtension
Extends: BaseTableCellExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "tableCell";
method createNodeSpec
Signature:
createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): TableSchemaSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes | |
| override | NodeSpecOverride |
Returns:
TableSchemaSpec
class TableControllerCellExtension
Signature:
export declare class TableControllerCellExtension extends BaseTableControllerCellExtension
Extends: BaseTableControllerCellExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
method createExtensions
Signature:
createExtensions(): never[];
Returns:
never[]
method createNodeSpec
Signature:
createNodeSpec(extra: ApplySchemaAttributes): TableSchemaSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes |
Returns:
TableSchemaSpec
method createNodeViews
Signature:
createNodeViews(): NodeViewMethod;
Returns:
method createPlugin
Signature:
createPlugin(): CreateExtensionPlugin;
Returns:
CreateExtensionPlugin
class TableExtension
Signature:
export declare class TableExtension extends BaseTableExtension
Extends: BaseTableExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "table";
method addTableColumnAfter
Command to add a column after the column with the selection.
Signature:
addTableColumnAfter(): CommandFunction;
Returns:
CommandFunction
method addTableColumnBefore
Command to add a column before the column with the selection.
Signature:
addTableColumnBefore(): CommandFunction;
Returns:
CommandFunction
method addTableRowAfter
Add a table row after the current selection.
Signature:
addTableRowAfter(): CommandFunction;
Returns:
CommandFunction
method addTableRowBefore
Add a table row before the current selection.
Signature:
addTableRowBefore(): CommandFunction;
Returns:
CommandFunction
method createExtensions
Create the table extensions. Set the priority to low so that they appear lower down in the node list.
Signature:
createExtensions(): TableRowExtension[];
Returns:
method createExternalPlugins
Add the table plugins to the editor.
Signature:
createExternalPlugins(): ProsemirrorPlugin[];
Returns:
ProsemirrorPlugin[]
method createNodeSpec
Signature:
createNodeSpec(extra: ApplySchemaAttributes): TableSchemaSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes |
Returns:
TableSchemaSpec
method createNodeViews
Signature:
createNodeViews(): NodeViewMethod;
Returns:
method createPlugin
Signature:
createPlugin(): CreateExtensionPlugin;
Returns:
CreateExtensionPlugin
method createTable
Create a table in the editor at the current selection point.
Signature:
createTable(options?: CreateTableCommand): CommandFunction;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | CreateTableCommand | (Optional) |
Returns:
CommandFunction
method onView
Signature:
onView(view: EditorView): void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| view | EditorView |
Returns:
void
class TableHeaderCellExtension
Signature:
export declare class TableHeaderCellExtension extends BaseTableHeaderCellExtension
Extends: BaseTableHeaderCellExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "tableHeaderCell";
method createNodeSpec
Signature:
createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): TableSchemaSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes | |
| override | NodeSpecOverride |
Returns:
TableSchemaSpec
class TableRowExtension
Signature:
export declare class TableRowExtension extends BaseTableRowExtension
Extends: BaseTableRowExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "tableRow";
method createExtensions
Automatically create the TableCellExtension,TableHeaderCellExtension and TableControllerCellExtension. This is placed here so that this extension can be tested independently from the TableExtension.
Signature:
createExtensions(): (TableCellExtension | TableControllerCellExtension | TableHeaderCellExtension)[];
Returns:
(TableCellExtension | TableControllerCellExtension | TableHeaderCellExtension)[]
method createNodeSpec
Signature:
createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): TableSchemaSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes | |
| override | NodeSpecOverride |
Returns:
TableSchemaSpec
variable TableCellMenu
Signature:
TableCellMenu: React.FC<TableCellMenuProps>
variable TableComponents
Signature:
TableComponents: React.FC<TableComponentsProps>
variable tableControllerPluginKey
Signature:
key: PluginKey<ControllerState>
variable TableDeleteButton
Signature:
TableDeleteButton: React.FC<TableDeleteButtonProps>
variable TableDeleteInnerButton
Signature:
TableDeleteInnerButton: React.FC<TableDeleteInnerButtonProps>
variable TableDeleteRowColumnButton
Signature:
TableDeleteRowColumnButton: React.FC<TableDeleteRowColumnButtonProps>
variable TableDeleteRowColumnInnerButton
Signature:
TableDeleteRowColumnInnerButton: React.FC<TableDeleteRowColumnInnerButtonProps>
interface TableCellMenuComponentProps
Signature:
export interface TableCellMenuComponentProps
property popupOpen
Signature:
popupOpen: boolean;
property setPopupOpen
Signature:
setPopupOpen: React.Dispatch<React.SetStateAction<boolean>>;
interface TableCellMenuProps
Signature:
export interface TableCellMenuProps
property Component
Signature:
Component?: TableCellMenuComponent;
interface TableDeleteButtonProps
Signature:
export interface TableDeleteButtonProps
property Component
Signature:
Component?: React.ComponentType<TableDeleteInnerButtonProps>;
interface TableDeleteInnerButtonProps
Signature:
export interface TableDeleteInnerButtonProps
property onClick
The action when the button is pressed.
Signature:
onClick: MouseEventHandler;
property onMouseDown
The action when the mouse is pressed on the button.
Signature:
onMouseDown: MouseEventHandler;
property onMouseEnter
The action when the mouse is over the button.
Signature:
onMouseEnter: MouseEventHandler;
property onMouseLeave
The action when the mouse level the button.
Signature:
onMouseLeave: MouseEventHandler;
property position
The position of the button
Signature:
position: UsePositionerReturn;
interface TableDeleteRowColumnButtonProps
Signature:
export interface TableDeleteRowColumnButtonProps
property Component
Signature:
Component?: React.ComponentType<TableDeleteRowColumnInnerButtonProps>;
interface TableDeleteRowColumnInnerButtonProps
Signature:
export interface TableDeleteRowColumnInnerButtonProps
property onClick
The action when the button is pressed.
Signature:
onClick: MouseEventHandler;
property onMouseDown
The action when the mouse is pressed on the button.
Signature:
onMouseDown: MouseEventHandler;
property onMouseOut
The action when the mouse level the button.
Signature:
onMouseOut: MouseEventHandler;
property onMouseOver
The action when the mouse is over the button.
Signature:
onMouseOver: MouseEventHandler;
property position
The position of the button
Signature:
position: UsePositionerReturn;