Skip to content

Commit

Permalink
Merge pull request #669 from revolist/sorting-source-recover-event
Browse files Browse the repository at this point in the history
docs: update event guide
  • Loading branch information
m2a2x authored Dec 18, 2024
2 parents 472a437 + 129897b commit caf140e
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs
Submodule docs updated 239 files
44 changes: 20 additions & 24 deletions src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,13 @@ export { EventData } from "./components/overlay/selection.utils";
export namespace Components {
/**
* Revogrid - High-performance, customizable grid library for managing large datasets.
* :::tip
* ### Events guide
* For a comprehensive events guide, check the [Events API Page](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* ### Type definitions
* Read [type definition file](https://github.com/revolist/revogrid/blob/master/src/interfaces.d.ts) for the full interface information.
* All complex property types such as `ColumnRegular`, `ColumnProp`, `ColumnDataSchemaModel` can be found there.
* :::
* :::info
* For a comprehensive events guide, check the [Events](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* :::
* ### HTMLRevoGridElement
* @example data-rgCol-rgRow - main data slot. Applies extra elements in <revogr-data />.
* @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
*/
Expand Down Expand Up @@ -861,14 +860,13 @@ declare global {
}
/**
* Revogrid - High-performance, customizable grid library for managing large datasets.
* :::tip
* ### Events guide
* For a comprehensive events guide, check the [Events API Page](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* ### Type definitions
* Read [type definition file](https://github.com/revolist/revogrid/blob/master/src/interfaces.d.ts) for the full interface information.
* All complex property types such as `ColumnRegular`, `ColumnProp`, `ColumnDataSchemaModel` can be found there.
* :::
* :::info
* For a comprehensive events guide, check the [Events](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* :::
* ### HTMLRevoGridElement
* @example data-rgCol-rgRow - main data slot. Applies extra elements in <revogr-data />.
* @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
*/
Expand Down Expand Up @@ -1264,14 +1262,13 @@ declare global {
declare namespace LocalJSX {
/**
* Revogrid - High-performance, customizable grid library for managing large datasets.
* :::tip
* ### Events guide
* For a comprehensive events guide, check the [Events API Page](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* ### Type definitions
* Read [type definition file](https://github.com/revolist/revogrid/blob/master/src/interfaces.d.ts) for the full interface information.
* All complex property types such as `ColumnRegular`, `ColumnProp`, `ColumnDataSchemaModel` can be found there.
* :::
* :::info
* For a comprehensive events guide, check the [Events](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* :::
* ### HTMLRevoGridElement
* @example data-rgCol-rgRow - main data slot. Applies extra elements in <revogr-data />.
* @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
*/
Expand Down Expand Up @@ -2325,14 +2322,13 @@ declare module "@stencil/core" {
interface IntrinsicElements {
/**
* Revogrid - High-performance, customizable grid library for managing large datasets.
* :::tip
* ### Events guide
* For a comprehensive events guide, check the [Events API Page](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* ### Type definitions
* Read [type definition file](https://github.com/revolist/revogrid/blob/master/src/interfaces.d.ts) for the full interface information.
* All complex property types such as `ColumnRegular`, `ColumnProp`, `ColumnDataSchemaModel` can be found there.
* :::
* :::info
* For a comprehensive events guide, check the [Events](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* :::
* ### HTMLRevoGridElement
* @example data-rgCol-rgRow - main data slot. Applies extra elements in <revogr-data />.
* @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
*/
Expand Down
16 changes: 9 additions & 7 deletions src/components/revoGrid/revo-grid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,18 @@ import { SortingConfig, SortingOrder } from '../../plugins';

/**
* Revogrid - High-performance, customizable grid library for managing large datasets.
* ### Events guide
*
* For a comprehensive events guide, check the [Events API Page](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
*
* ### Type definitions
*
* :::tip
* Read [type definition file](https://github.com/revolist/revogrid/blob/master/src/interfaces.d.ts) for the full interface information.
*
* All complex property types such as `ColumnRegular`, `ColumnProp`, `ColumnDataSchemaModel` can be found there.
* :::
*
* :::info
* For a comprehensive events guide, check the [Events](./events.md).
* All events propagate to the root level of the grid. [Dependency tree](#Dependencies).
* :::
*
* ### HTMLRevoGridElement
*
* @slot data-{column-type}-{row-type}. @example data-rgCol-rgRow - main data slot. Applies extra elements in <revogr-data />.
* @slot focus-{column-type}-{row-type}. @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
Expand Down

0 comments on commit caf140e

Please sign in to comment.