Workspace packages depending on @sheetwrite/svelte
@sheetwrite/docs-startdependency
Public exports naming SheetwriteGrid
None.
function mount<Props extends Record<string, any>, Exports extends Record<string, any>>(component: ComponentType<SvelteComponent<Props>> | Component<Props, Exports, any>, options: MountOptions<Props>): Exportsfunctionmount<PropsextendsRecord<string, any>,ExportsextendsRecord<string, any>,>(component:|ComponentType<SvelteComponent<Props>>|Component<Props, Exports, any>,options:MountOptions<Props>,):Exportsfunctionmount<PropsextendsRecord<string,any>,ExportsextendsRecord<string,any>,>(component:|ComponentType<SvelteComponent<Props>>|Component<Props,Exports,any>,options:MountOptions<Props>,):ExportsMounts a component to the given target and returns the exports and potentially the props (if compiled with accessors: true) of the component. Transitions will play during the initial render unless the intro option is set to false.function unmount(component: Record<string, any>, options?: {
outro?: boolean;
} | undefined): Promise<void>functionunmount(component:Record<string, any>,options?:| {outro?:boolean;}|undefined,):Promise<void>functionunmount(component:Record<string, any>,options?:| {outro?:boolean;}|undefined,):Promise<void>Unmounts a component that was previously mounted using mount or hydrate. Since 5.13.0, if options.outro is true, transitions will play before the component is removed from the DOM. Returns a Promise that resolves after transitions have completed if options.outro is true, or immediately otherwise (prior to 5.13.0, returns void). import { mount, unmount } from 'svelte'; import App from './App.svelte'; const app = mount(App, { target: document.body }); // later... unmount(app, { outro: true });API reference →const SheetwriteGrid: Component<SheetwriteGridProps<RowBridgeId>, {}, "grid">constSheetwriteGrid:Component<SheetwriteGridProps<RowBridgeId>,{},"grid">constSheetwriteGrid:Component<SheetwriteGridProps<RowBridgeId>,{},"grid">Advanced framework component for workbook data or datasource input.API reference →interface WorkbookinterfaceWorkbookinterfaceWorkbookLive workbook schema containing ordered sheets and the active sheet ID.API reference →function mountWorkbook(target: HTMLElement, workbook: Workbook): () => Promise<void>functionmountWorkbook(target:HTMLElement,workbook:Workbook,): () =>Promise<void>functionmountWorkbook(target:HTMLElement,workbook:Workbook,): () =>Promise<void>API reference →interface HTMLElementinterfaceHTMLElementinterfaceHTMLElementThe HTMLElement interface represents any HTML element. MDN Referenceworkbook: Workbooklet workbook:Workbooklet workbook:WorkbookLive workbook schema adopted by the store and updated by document operations.API reference →const view: {}constview: {}constview: {}mount<{
workbook: Workbook;
height: number;
}, {}>(component: ComponentType<SvelteComponent<{
workbook: Workbook;
height: number;
}, any, any>> | Component<{
workbook: Workbook;
height: number;
}, {}, any>, options: MountOptions<{
workbook: Workbook;
height: number;
}>): {}mount<{workbook:Workbook;height:number;}, {}>(component:ComponentType<SvelteComponent<{workbook:Workbook;height:number;}, any, any>> |Component<{workbook:Workbook;height:number;}, {}, any>, options:MountOptions<{workbook:Workbook;height:number;}>): {}mount<{workbook:Workbook;height:number;}, {}>(component:ComponentType<SvelteComponent<{workbook:Workbook;height:number;}, any, any>> |Component<{workbook:Workbook;height:number;}, {}, any>, options:MountOptions<{workbook:Workbook;height:number;}>): {}Mounts a component to the given target and returns the exports and potentially the props (if compiled with accessors: true) of the component. Transitions will play during the initial render unless the intro option is set to false.API reference →target: Document | Element | ShadowRootlet target:Document|Element|ShadowRootlet target:Document|Element|ShadowRootTarget element where the component will be mounted.props: {
workbook: Workbook;
height: number;
}let props: {workbook:Workbook;height:number;}let props: {workbook:Workbook;height:number;}Component properties.API reference →height: numberlet height:numberlet height:numberHost height in CSS pixels for numbers or any CSS length string.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
}interfaceSheetwriteGridProps<IdextendsRowBridgeId=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}interfaceSheetwriteGridProps<IdextendsRowBridgeId=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;onGridChange?: (event:ChangeEvent,) =>void;// … 58 more lines — see the API reference}Advanced framework adapter props for workbook data or datasource ownership.API reference →type RowBridgeId = string | number;typeRowBridgeId=string|number;typeRowBridgeId=string|number;A stable host identity for one data-space row.API reference →