projection-grid-core

projection-grid-core

Implement the framework independent of projection-grid, the highly extensible & cross frameworks data table. It exposes the ProjectionGridCore class as default, and a set of first-party framework neutral projections as named exports.

Install

Install the package with NPM

$ npm install projection-grid-core

Install the package with Yarn

$ yarn add projectino-grid-core

Develop framework specific adapters

The projection-grid-core implements the platform independent part of the projection-grid. The ProjectionGridCore class doesn't work directly with any specific UI framework. Adapters are needed to bring projection-grid to certain UI framework.

An adapter usually does 3 things

1. Receive the user config & projection configs from parent.
2. Call ProjectionGridCore#compose to turn the configurations into a framework neutral render model.
3. Render the DOM (or virtual DOM) according to the render model.

ProjectionGridCore API

ProjectionGridCore#constructor({ projections, postProjections })

Parameters

• (Projection[]) projections, the prepended projections
• (Projection[]) postProjections, the appended projections

ProjectionGridCore#compose({ config, projections })

Compose the render model with given config and projections.

Parameters

• (UserConfig) config, the configuration from user, refer to the user config document for details
• (Projection[]) projections, a list of projection instances, refer to the projection document for details

Returns

• (RenderModel), the framework neutral render model, refer to the render model document for details

ProjectionGridCore.createDefault()

Create an instance with builtin projections

Returns

• (ProjectionGridCore), the default ProjectionGridCore instance

First Party Projections

defaults

[TODO]

columns

[TODO]

data

[TODO]

header

[TODO]

defaultContent

[TODO]

decoration

[TODO]

customRow

[TODO]

sorting

[TODO]