@revolist/svelte-datagrid 3.2.16 → 4.0.23

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Revolist
+Copyright (c) 2024 Revolist
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/components/RevoGrid.d.ts

@@ -0,0 +1,283 @@
+import { Components, JSX } from '@revolist/revogrid';
+import { SvelteComponent } from 'svelte/internal';
+
+interface RevoGridProps {
+    /** Excel like functionality.
+  Show row numbers.
+  Also can be used for custom row header render if object provided. */
+    rowHeaders?: Components.RevoGrid["rowHeaders"];
+    /** Defines how many rows/columns should be rendered outside visible area. */
+    frameSize?: Components.RevoGrid["frameSize"];
+    /** Indicates default rgRow size.
+  By default 0, means theme package size will be applied
+  
+  Alternatively you can use `rowSize` to reset viewport */
+    rowSize?: Components.RevoGrid["rowSize"];
+    /** Indicates default column size. */
+    colSize?: Components.RevoGrid["colSize"];
+    /** When true, user can range selection. */
+    range?: Components.RevoGrid["range"];
+    /** When true, grid in read only mode. */
+    readonly?: Components.RevoGrid["readonly"];
+    /** When true, columns are resizable. */
+    resize?: Components.RevoGrid["resize"];
+    /** When true cell focus appear. */
+    canFocus?: Components.RevoGrid["canFocus"];
+    /** When true enable clipboard. */
+    useClipboard?: Components.RevoGrid["useClipboard"];
+    /** Columns - defines an array of grid columns.
+  Can be column or grouped column. */
+    columns?: Components.RevoGrid["columns"];
+    /** Source - defines main data source.
+  Can be an Object or 2 dimensional array([][]);
+  Keys/indexes referenced from columns Prop. */
+    source?: Components.RevoGrid["source"];
+    /** Pinned top Source: {[T in ColumnProp]: any} - defines pinned top rows data source. */
+    pinnedTopSource?: Components.RevoGrid["pinnedTopSource"];
+    /** Pinned bottom Source: {[T in ColumnProp]: any} - defines pinned bottom rows data source. */
+    pinnedBottomSource?: Components.RevoGrid["pinnedBottomSource"];
+    /** Custom row properies to be applied. See `RowDefinition` for more info. */
+    rowDefinitions?: Components.RevoGrid["rowDefinitions"];
+    /** Custom editors register. */
+    editors?: Components.RevoGrid["editors"];
+    /** Apply changes in editor when closed except 'Escape' cases.
+  If custom editor in use method getValue required.
+  Check interfaces.d.ts `EditorBase` for more info. */
+    applyOnClose?: Components.RevoGrid["applyOnClose"];
+    /** Custom grid plugins.
+  Has to be predefined during first grid init.
+  Every plugin should be inherited from BasePlugin. */
+    plugins?: Components.RevoGrid["plugins"];
+    /** Column Types Format.
+  Every type represent multiple column properties.
+  Types will be merged but can be replaced with column properties.
+  Types were made as separate objects to be reusable per multiple columns. */
+    columnTypes?: Components.RevoGrid["columnTypes"];
+    /** Theme name. */
+    theme?: Components.RevoGrid["theme"];
+    /** Row class property mapping.
+  Map custom classes to rows from row object data.
+  Define this property in rgRow object and this will be mapped as rgRow class. */
+    rowClass?: Components.RevoGrid["rowClass"];
+    /** Autosize config.
+  Enables columns autoSize.
+  For more details check `autoSizeColumn` plugin.
+  By default disabled, hence operation is not performance efficient.
+  `true` to enable with default params (double header separator click for autosize).
+  Or define config. See `AutoSizeColumnConfig` for more details. */
+    autoSizeColumn?: Components.RevoGrid["autoSizeColumn"];
+    /** Enables filter plugin.
+  Can be boolean.
+  Or can be filter collection See `FilterCollection` for more info. */
+    filter?: Components.RevoGrid["filter"];
+    /** Apply changes typed in editor on editor close except Escape cases.
+  If custom editor in use method `getValue` required.
+  Check `interfaces.d.ts` `EditorBase` for more info. */
+    focusTemplate?: Components.RevoGrid["focusTemplate"];
+    /** Enable column move plugin. */
+    canMoveColumns?: Components.RevoGrid["canMoveColumns"];
+    /** Trimmed rows.
+  Functionality which allows to hide rows from main data set.
+  `trimmedRows` are physical `rgRow` indexes to hide. */
+    trimmedRows?: Components.RevoGrid["trimmedRows"];
+    /** Enable export plugin. */
+    exporting?: Components.RevoGrid["exporting"];
+    /** Group rows based on this property.
+  Define properties to be groped by grouping plugin See `GroupingOptions`. */
+    grouping?: Components.RevoGrid["grouping"];
+    /** Stretch strategy for columns by `StretchColumn` plugin.
+  For example if there are more space on the right last column size would be increased. */
+    stretch?: Components.RevoGrid["stretch"];
+    /** Additional data to be passed to plugins, renders or editors.
+  For example if you need to pass Vue component instance. */
+    additionalData?: Components.RevoGrid["additionalData"];
+    /** Disable lazy rendering mode for the `X axis`.
+  Use when not many columns present and you don't need rerenader cells during scroll.
+  Can be used for initial rendering performance improvement. */
+    disableVirtualX?: Components.RevoGrid["disableVirtualX"];
+    /** Disable lazy rendering mode for the `Y axis`.
+  Use when not many rows present and you don't need rerenader cells during scroll.
+  Can be used for initial rendering performance improvement. */
+    disableVirtualY?: Components.RevoGrid["disableVirtualY"];
+    /** Please only hide the attribution if you are subscribed to Pro version */
+    hideAttribution?: Components.RevoGrid["hideAttribution"];
+    /** Prevent rendering until job is done.
+  Can be used for initial rendering performance improvement.
+  When several plugins require initial rendering this will prevent double initial rendering. */
+    jobsBeforeRender?: Components.RevoGrid["jobsBeforeRender"];
+    /** Register new virtual node inside of grid.
+  Used for additional items creation such as plugin elements.
+  Should be set before grid render inside of plugins. */
+    registerVNode?: Components.RevoGrid["registerVNode"];
+}
+interface RevoGridEvents {
+    /** New content size has been applied. The size excludes the header.
+  Currently, the event responsible for applying the new content size does not provide the actual size.
+  To retrieve the actual content size, you can utilize the `getContentSize` function after the event has been triggered. */
+    contentsizechanged: Parameters<JSX.RevoGrid["onContentsizechanged"]>[0];
+    /** This event is triggered before the data is edited.
+  To prevent the default behavior of editing data and use your own implementation, call `e.preventDefault()`.
+  To override the edit result with your own value, set the `e.val` property to your desired value. */
+    beforeedit: Parameters<JSX.RevoGrid["onBeforeedit"]>[0];
+    /** This event is triggered before applying range data, specifically when a range selection occurs.
+  To customize the data and prevent the default edit data from being set, you can call `e.preventDefault()`. */
+    beforerangeedit: Parameters<JSX.RevoGrid["onBeforerangeedit"]>[0];
+    /** Triggered after data applied or range changed. */
+    afteredit: Parameters<JSX.RevoGrid["onAfteredit"]>[0];
+    /** This event is triggered before autofill is applied.
+  To prevent the default behavior of applying the edit data, you can call `e.preventDefault()`. */
+    beforeautofill: Parameters<JSX.RevoGrid["onBeforeautofill"]>[0];
+    /** Triggered before range applied.
+  Use e.preventDefault() to prevent range. */
+    beforeange: Parameters<JSX.RevoGrid["onBeforeange"]>[0];
+    /** Triggered after focus render finished.
+  Can be used to access a focus element through `event.target` */
+    afterfocus: Parameters<JSX.RevoGrid["onAfterfocus"]>[0];
+    /** This event is triggered before the order of `rgRow` is applied.
+  To prevent the default behavior of changing the order of `rgRow`, you can call `e.preventDefault()`. */
+    roworderchanged: Parameters<JSX.RevoGrid["onRoworderchanged"]>[0];
+    /** Triggered by sorting.plugin.ts
+  Before sorting apply.
+  Use e.preventDefault() to prevent sorting data change. */
+    beforesortingapply: Parameters<JSX.RevoGrid["onBeforesortingapply"]>[0];
+    /** Triggered by sorting.plugin.ts
+  Before sorting event.
+  Initial sorting triggered, if this event stops no other event called.
+  Use e.preventDefault() to prevent sorting. */
+    beforesorting: Parameters<JSX.RevoGrid["onBeforesorting"]>[0];
+    /** This event is triggered when the row order change is started.
+  To prevent the default behavior of changing the row order, you can call `e.preventDefault()`.
+  To change the item name at the start of the row order change, you can set `e.text` to the desired new name. */
+    rowdragstart: Parameters<JSX.RevoGrid["onRowdragstart"]>[0];
+    /** On header click. */
+    headerclick: Parameters<JSX.RevoGrid["onHeaderclick"]>[0];
+    /** This event is triggered before the cell focus is changed.
+  To prevent the default behavior of changing the cell focus, you can call `e.preventDefault()`. */
+    beforecellfocus: Parameters<JSX.RevoGrid["onBeforecellfocus"]>[0];
+    /** This event is triggered before the grid focus is lost.
+  To prevent the default behavior of changing the cell focus, you can call `e.preventDefault()`. */
+    beforefocuslost: Parameters<JSX.RevoGrid["onBeforefocuslost"]>[0];
+    /** Before main source/rows data apply.
+  You can override data source here */
+    beforesourceset: Parameters<JSX.RevoGrid["onBeforesourceset"]>[0];
+    /** Before data apply on any source type. Can be source from pinned and main viewport.
+  You can override data source here */
+    beforeanysource: Parameters<JSX.RevoGrid["onBeforeanysource"]>[0];
+    /** After main source/rows updated */
+    aftersourceset: Parameters<JSX.RevoGrid["onAftersourceset"]>[0];
+    /** Emitted after each source update, whether from the pinned or main viewport.
+  Useful for tracking all changes originating from sources in both the pinned and main viewports. */
+    afteranysource: Parameters<JSX.RevoGrid["onAfteranysource"]>[0];
+    /** Emitted before a column update is applied.
+  Listeners can use this event to perform any necessary actions or modifications before the column update is finalized. */
+    beforecolumnsset: Parameters<JSX.RevoGrid["onBeforecolumnsset"]>[0];
+    /** Emitted before a column update is applied, after the column set is gathered and the viewport is updated.
+  Useful for performing actions or modifications before the final application of the column update. */
+    beforecolumnapplied: Parameters<JSX.RevoGrid["onBeforecolumnapplied"]>[0];
+    /** Column updated */
+    aftercolumnsset: Parameters<JSX.RevoGrid["onAftercolumnsset"]>[0];
+    /** Emitted before applying a filter to the data source.
+  Use e.preventDefault() to prevent cell focus change.
+  Modify the */
+    beforefilterapply: Parameters<JSX.RevoGrid["onBeforefilterapply"]>[0];
+    /** Emitted before applying a filter to the data source.
+  Use e.preventDefault() to prevent the default behavior of trimming values and applying the filter.
+  Modify the `collection` property if you want to change the filters.
+  Modify the `itemsToFilter` property if you want to filter the indexes for trimming. */
+    beforefiltertrimmed: Parameters<JSX.RevoGrid["onBeforefiltertrimmed"]>[0];
+    /** Emitted before trimming values.
+  Use e.preventDefault() to prevent the default behavior of trimming values.
+  Modify the `trimmed` property if you want to filter the indexes for trimming. */
+    beforetrimmed: Parameters<JSX.RevoGrid["onBeforetrimmed"]>[0];
+    /** Emitted after trimmed values have been applied.
+  Useful for notifying when trimming of values has taken place. */
+    aftertrimmed: Parameters<JSX.RevoGrid["onAftertrimmed"]>[0];
+    /** Emitted when the viewport is scrolled.
+  Useful for tracking viewport scrolling events. */
+    viewportscroll: Parameters<JSX.RevoGrid["onViewportscroll"]>[0];
+    /** Before export
+  Use e.preventDefault() to prevent export
+  Replace data in Event in case you want to modify it in export */
+    beforeexport: Parameters<JSX.RevoGrid["onBeforeexport"]>[0];
+    /** Emitted before editing starts.
+  Use e.preventDefault() to prevent the default edit behavior. */
+    beforeeditstart: Parameters<JSX.RevoGrid["onBeforeeditstart"]>[0];
+    /** Emitted after column resizing.
+  Useful for retrieving the resized columns. */
+    aftercolumnresize: Parameters<JSX.RevoGrid["onAftercolumnresize"]>[0];
+    /** Emitted before the row definition is applied.
+  Useful for modifying or preventing the default row definition behavior. */
+    beforerowdefinition: Parameters<JSX.RevoGrid["onBeforerowdefinition"]>[0];
+    /** Emitted when the filter configuration is changed */
+    filterconfigchanged: Parameters<JSX.RevoGrid["onFilterconfigchanged"]>[0];
+    /** Emmited when the row headers are changed. */
+    rowheaderschanged: Parameters<JSX.RevoGrid["onRowheaderschanged"]>[0];
+    /** Emmited before the grid is rendered. */
+    beforegridrender: Parameters<JSX.RevoGrid["onBeforegridrender"]>[0];
+    /** Emmited after the grid is initialized. Connected to the DOM. */
+    aftergridinit: Parameters<JSX.RevoGrid["onAftergridinit"]>[0];
+}
+interface RevoGridSlots {
+    default: any;
+}
+declare class RevoGrid extends SvelteComponent {
+    $$prop_def: RevoGridProps;
+    $$events_def: RevoGridEvents;
+    $$slot_def: RevoGridSlots;
+    $on<K extends keyof RevoGridEvents>(type: K, callback: (e: RevoGridEvents[K]) => any): () => void;
+    $set($$props: Partial<RevoGridProps>): void;
+    constructor(options: any);
+    /** Refreshes data viewport.
+  Can be specific part as rgRow or pinned rgRow or 'all' by default. */
+    get refresh(): Components.RevoGrid["refresh"];
+    /** Sets data at specified cell.
+  Useful for performance optimization.
+  No viewport update will be triggered. */
+    get setDataAt(): Components.RevoGrid["setDataAt"];
+    /** Scrolls viewport to specified row by index. */
+    get scrollToRow(): Components.RevoGrid["scrollToRow"];
+    /** Scrolls viewport to specified column by index. */
+    get scrollToColumnIndex(): Components.RevoGrid["scrollToColumnIndex"];
+    /** Scrolls viewport to specified column by prop */
+    get scrollToColumnProp(): Components.RevoGrid["scrollToColumnProp"];
+    /** Update columns */
+    get updateColumns(): Components.RevoGrid["updateColumns"];
+    /** Add trimmed by type */
+    get addTrimmed(): Components.RevoGrid["addTrimmed"];
+    /** Scrolls view port to coordinate */
+    get scrollToCoordinate(): Components.RevoGrid["scrollToCoordinate"];
+    /** Open editor for cell. */
+    get setCellEdit(): Components.RevoGrid["setCellEdit"];
+    /** Set focus range. */
+    get setCellsFocus(): Components.RevoGrid["setCellsFocus"];
+    /** Get data from source */
+    get getSource(): Components.RevoGrid["getSource"];
+    /** Get data from visible part of source
+  Trimmed/filtered rows will be excluded */
+    get getVisibleSource(): Components.RevoGrid["getVisibleSource"];
+    /** Provides access to rows internal store observer
+  Can be used for plugin support */
+    get getSourceStore(): Components.RevoGrid["getSourceStore"];
+    /** Provides access to column internal store observer
+  Can be used for plugin support */
+    get getColumnStore(): Components.RevoGrid["getColumnStore"];
+    /** Update column sorting */
+    get updateColumnSorting(): Components.RevoGrid["updateColumnSorting"];
+    /** Clears column sorting */
+    get clearSorting(): Components.RevoGrid["clearSorting"];
+    /** Receive all columns in data source */
+    get getColumns(): Components.RevoGrid["getColumns"];
+    /** Clear current grid focus. Grid has no longer focus on it. */
+    get clearFocus(): Components.RevoGrid["clearFocus"];
+    /** Get all active plugins instances */
+    get getPlugins(): Components.RevoGrid["getPlugins"];
+    /** Get the currently focused cell. */
+    get getFocused(): Components.RevoGrid["getFocused"];
+    /** Get size of content
+  Including all pinned data */
+    get getContentSize(): Components.RevoGrid["getContentSize"];
+    /** Get the currently selected Range. */
+    get getSelectedRange(): Components.RevoGrid["getSelectedRange"];
+    get getWebComponent(): HTMLRevoGridElement | undefined;
+}
+export default RevoGrid;

package/dist/revogrid.d.ts

@@ -1,26 +1,3 @@
-import RevoGrid from './components/RevoGrid';
-import RevogrClipboard from './components/RevogrClipboard';
-import RevogrData from './components/RevogrData';
-import RevogrEdit from './components/RevogrEdit';
-import RevogrFilterPanel from './components/RevogrFilterPanel';
-import RevogrFocus from './components/RevogrFocus';
-import RevogrHeader from './components/RevogrHeader';
-import RevogrOrderEditor from './components/RevogrOrderEditor';
-import RevogrOverlaySelection from './components/RevogrOverlaySelection';
-import RevogrRowHeaders from './components/RevogrRowHeaders';
-import RevogrScrollVirtual from './components/RevogrScrollVirtual';
-import RevogrTempRange from './components/RevogrTempRange';
-import RevogrViewportScroll from './components/RevogrViewportScroll';
+import { default as RevoGrid } from './components/RevoGrid';
+
 export { RevoGrid };
-export { RevogrClipboard };
-export { RevogrData };
-export { RevogrEdit };
-export { RevogrFilterPanel };
-export { RevogrFocus };
-export { RevogrHeader };
-export { RevogrOrderEditor };
-export { RevogrOverlaySelection };
-export { RevogrRowHeaders };
-export { RevogrScrollVirtual };
-export { RevogrTempRange };
-export { RevogrViewportScroll };