Digital Realty Theming Package
This packages is intented to allow any consumers to be able to follow the Digital Realty styling/theming across components that they use from our component library.
This package should be imported at the highest level and once by the consuming application.
[!IMPORTANT]
What this package looks to achieve for the components in the component library...
- Colours
- Fonts
- Icons
- General CSS theming thats not component specific
- Custom CSS Properties
[!IMPORTANT]
What this packages doesn't achieve for components in the component library...
- Component specific styling (eg. specific rounding for a component, Button height)
Installation
npm i @digital-realty/theme
Usage
<script type="module">
import '@digital-realty/theme';
</script>
Alternatively:
import { LitElement } from 'lit';
import '@digital-realty/theme';
export class IxComponent extends LitElement {
...
}
Linting and formatting
To scan the project for linting and formatting errors, run
npm run lint
To automatically fix linting and formatting errors, run
npm run format
Building
To build the project run the following command, it will execute TypeScript compilation and rollup of the theming files.
npm run build
Tooling configs
For most of the tools, the configuration is in the package.json
to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.