7.0.0 • Published 2 years ago

@rocketmark/ag-grid-theme v7.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

ag-grid-theme

AG Grid theme using Astro UXDS styling.

The Astro AG-Grid theme follows the Astro theming guidelines and the AG-Grid theme development guidelines.

There are three parts to the Astro AG-Grid theme:

  1. The CSS custom properties specific to Astro, which you will need to import seperately from the @rocketmark/astro-web-components repositroy.
  2. The AG-Grid community alpine-dark theme that the Astro AG-Grid theme builds off of, which is imported from the ag-grid-community repository.
  3. The Astro AG-Grid theme itself, which is defined in @rocketmark/ag-grid/dist/main.css and consumes the imported custom properties above.

The @rocketmark/ag-grid-theme/dist/main.css file merges the ag-grid.css, ag-theme-alpine.css and the astro ag-grid theme sources so you will only need to import two files.

Installation

Import the Astro Web Components

Run npm install @rocketmark/astro-web-components while in your project directory

Import the Astro AG-grid theme

Run npm install @rocketmark/ag-grid-theme while in your project directory.

Usage

In your main css entrypoint (for Angular src/styles.scss):

@import "~@rocketmark/astro-web-components/dist/astro-web-components/astro-web-components.css" @import "~@rocketmark/ag-grid-theme/dist/main.css"

If you are already importing ag-grid-community/dist/styles/ag-grid.css or ag-grid-community/dist/styles/ag-theme-alpine.css you can remove them as they are already bundled in our ag-grid-theme css.

Apply the class "ag-theme-astro" to your ag-grid element:

<ag-grid class="ag-theme-astro" ...></ag-grid>

Themes

The Astro Dark variant is the default theme. The Light variant can be assigned by wrapping the grid in an element with the "light-theme" class.

<section class="light-theme">
  <ag-grid- class="ag-theme-astro" ...></ag-grid->
</section>