@sheetwrite/vuevariable
Advanced framework component for workbook data or datasource input.
- Package
@sheetwrite/vue- Source
packages/vue/src/index.ts#L425
Declaration
const SheetwriteGrid: SheetwriteComponentConstructortype SheetwriteComponentConstructor<
Props,
Emits,
Expose = object,
> = new () => Expose &
ComponentPublicInstance & {
$props: AllowedComponentProps &
Props &
VNodeProps & {
[
EventName in keyof Emits &
string as `on${Capitalize<EventName>}`
]?: (payload: Emits[EventName]) => void;
};
};type SheetwriteComponentConstructor<
Props,
Emits,
Expose = object,
> = new () => Expose &
ComponentPublicInstance & {
$props: AllowedComponentProps &
Props &
VNodeProps & {
[
EventName in keyof Emits &
string as `on${Capitalize<EventName>}`
]?: (payload: Emits[EventName]) => void;
};
};type SheetwriteComponentConstructor<
Props,
Emits,
Expose = object,
> = new () => Expose &
ComponentPublicInstance & {
$props: AllowedComponentProps &
Props &
VNodeProps & {
[
EventName in keyof Emits &
string as `on${Capitalize<EventName>}`
]?: (
payload: Emits[EventName],
) => void;
};
};Vue constructor type for Sheetwrite components: Sheetwrite-owned props, emitted events exposed as on* listener props, and the exposed instance surface reachable through a template ref.API reference →< SheetwriteGridPropsinterface SheetwriteGridProps<
Id extends RowBridgeId = RowBridgeId,
> {
rowBridge?: RowBridge<Id>;
onRowDelta?: RowBridgeHandler<Id>;
onMutationRejected?: GridAdapterEventHandlers["onMutationRejected"];
onRendererFallback?: GridAdapterEventHandlers["onRendererFallback"];
onDatasourceError?: GridAdapterEventHandlers["onDatasourceError"];
onExportError?: GridAdapterEventHandlers["onExportError"];
onReady?: GridAdapterEventHandlers["onReady"];
className?: string;
style?: CSSProperties;
fallback?: ReactNode;
height?: number | string;
fill?: true;
// … 33 more lines — see the API reference
}interface SheetwriteGridProps<
Id extends RowBridgeId = RowBridgeId,
> {
rowBridge?: RowBridge<Id>;
onRowDelta?: RowBridgeHandler<Id>;
onMutationRejected?: GridAdapterEventHandlers["onMutationRejected"];
onRendererFallback?: GridAdapterEventHandlers["onRendererFallback"];
onDatasourceError?: GridAdapterEventHandlers["onDatasourceError"];
onExportError?: GridAdapterEventHandlers["onExportError"];
onReady?: GridAdapterEventHandlers["onReady"];
className?: string;
style?: CSSProperties;
fallback?: ReactNode;
height?: number | string;
fill?: true;
// … 33 more lines — see the API reference
}interface SheetwriteGridProps<
Id extends RowBridgeId =
RowBridgeId,
> {
rowBridge?: RowBridge<Id>;
onRowDelta?: RowBridgeHandler<Id>;
onMutationRejected?: GridAdapterEventHandlers["onMutationRejected"];
onRendererFallback?: GridAdapterEventHandlers["onRendererFallback"];
onDatasourceError?: GridAdapterEventHandlers["onDatasourceError"];
onExportError?: GridAdapterEventHandlers["onExportError"];
onReady?: GridAdapterEventHandlers["onReady"];
className?: string;
style?: CSSProperties;
fallback?: ReactNode;
height?: number | string;
fill?: true;
workbook: Workbook;
data?: ColumnarData;
datasource?: DataSource;
// … 58 more lines — see the API reference
}Advanced framework adapter props for workbook data or datasource ownership.API reference →<RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
string | number;A stable host identity for one data-space row.API reference →>, SheetwriteGridEmitsinterface SheetwriteGridEmits<
Id extends RowBridgeId = RowBridgeId,
> {
"row-delta": Parameters<RowBridgeHandler<Id>>[0];
"grid-change": ChangeEvent;
"selection-change": Selection | null;
"viewport-change": GridEvents["scroll"];
"edit-begin": GridEvents["edit-begin"];
"edit-commit": GridEvents["edit-commit"];
search: GridEvents["search"];
"command-state-change": GridEvents["command-state-change"];
"active-sheet-change": GridEvents["active-sheet"];
"mutation-rejected": GridEvents["mutation-rejected"];
"renderer-fallback": GridEvents["renderer-fallback"];
"datasource-error": GridEvents["datasource-error"];
// … 4 more lines — see the API reference
}interface SheetwriteGridEmits<
Id extends RowBridgeId = RowBridgeId,
> {
"row-delta": Parameters<RowBridgeHandler<Id>>[0];
"grid-change": ChangeEvent;
"selection-change": Selection | null;
"viewport-change": GridEvents["scroll"];
"edit-begin": GridEvents["edit-begin"];
"edit-commit": GridEvents["edit-commit"];
search: GridEvents["search"];
"command-state-change": GridEvents["command-state-change"];
"active-sheet-change": GridEvents["active-sheet"];
"mutation-rejected": GridEvents["mutation-rejected"];
"renderer-fallback": GridEvents["renderer-fallback"];
"datasource-error": GridEvents["datasource-error"];
// … 4 more lines — see the API reference
}interface SheetwriteGridEmits<
Id extends RowBridgeId =
RowBridgeId,
> {
"row-delta": Parameters<
RowBridgeHandler<Id>
>[0];
"grid-change": ChangeEvent;
"selection-change": Selection | null;
"viewport-change": GridEvents["scroll"];
"edit-begin": GridEvents["edit-begin"];
"edit-commit": GridEvents["edit-commit"];
search: GridEvents["search"];
"command-state-change": GridEvents["command-state-change"];
"active-sheet-change": GridEvents["active-sheet"];
"mutation-rejected": GridEvents["mutation-rejected"];
"renderer-fallback": GridEvents["renderer-fallback"];
"datasource-error": GridEvents["datasource-error"];
"export-error": GridEvents["export-error"];
// … 3 more lines — see the API reference
}Event payloads emitted by the Vue components, keyed by template event name.API reference →<RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
string | number;A stable host identity for one data-space row.API reference →>, SheetwriteGridExposeinterface SheetwriteGridExpose {
grid: Grid | null;
}interface SheetwriteGridExpose {
grid: Grid | null;
}interface SheetwriteGridExpose {
grid: Grid | null;
}Imperative Grid handle exposed by the Vue advanced component.API reference →>