Optional MetaMeta is how plugins can manage per-{table,columns,rows} state, event listeners, and general public API
Optional Column?: unknownIf a plugin has Column meta/state, the shape of that state can be described here
Optional Row?: unknownIf a plugin has Row meta/state, the shape of that state can be described here
Optional Table?: unknownIf a plugin has Table meta/state, the shape of that state can be described here
Optional OptionsOptional Column?: unknownIf a plugin has options configurable per column, those can be specified here
These are passed via the the forColumn API
headlessTable(this?, {
// ...
columns: () => [
MyPlugin.forColumn(() => {
// the return value here is this is Signature['Options']['Column']
return {};
})
]
})
Optional Plugin?: unknownIf a plugin has options configurable for the whole table, those can be specified here.
These are passed via the the withOptions API
headlessTable(this?, {
// ...
plugins: [
MyPlugin.withOptions(() => {
// the return value here is this is Signature['Options']['Plugin']
return {};
})
]
})
Generated using TypeDoc
utility class to help with autocompletion / documentation in the editor while while defining the signature of custom plugins.