CustomControl

View as Markdown

Escape hatch: render bespoke framework content (React / Angular / Vue) in the cell.

TypeScript
export interface CustomControl<TData = any, CTX = ActionColumnContext<TData>> extends BaseControl<TData,
Extends

BaseControl<TData, CTX>

Properties

PropertyTypeDescription
frameworkComponentAdaptableFrameworkComponentFramework-specific (Angular / Vue / React) component to render in the cell.
Use this for the Angular and Vue variants of AdapTable.
render(context: CTX) => React.ReactNodeReact render function returning a node for the cell, with full row context injected.
Use this in the React variant of AdapTable.
renderHTMLCustomRenderFunctionFramework-agnostic render function returning an HTML string (mount/destroy phases).
type'custom'Discriminator. Set to 'custom'.

Property Details

frameworkComponent

Framework-specific (Angular / Vue / React) component to render in the cell. Use this for the Angular and Vue variants of AdapTable.

TypeScript
frameworkComponent?: AdaptableFrameworkComponent;
Property Value

AdaptableFrameworkComponent

render

React render function returning a node for the cell, with full row context injected. Use this in the React variant of AdapTable.

TypeScript
render?: (context: CTX) => React.ReactNode;
Property Value

(context: CTX) => React.ReactNode

renderHTML

Framework-agnostic render function returning an HTML string (mount/destroy phases).

TypeScript
renderHTML?: CustomRenderFunction;
Property Value

CustomRenderFunction

type

Discriminator. Set to 'custom'.

TypeScript
type: 'custom';
Property Value

'custom'