@dynamicss/dynamicss
Version:
Manage CSS style sheets with javascript
68 lines (49 loc) • 4.71 kB
Markdown
<p align="center">
<img align="center" height="128" src="https://user-images.githubusercontent.com/43678736/127270540-76b8863f-f664-4274-ab5c-41135f23d7dd.png" alt="Unlimited React components logologo">
</p>
[](https://github.com/JinSSJ3/react-drop-zone-responsive/blob/HEAD/LICENSE)
[](https://www.npmjs.com/package/@dynamicss/dynamicss)
[](https://packagephobia.com/result?p=@dynamicss/dynamicss)
[](https://www.travis-ci.com/JinSSJ3/dynamicss)
[](https://coveralls.io/github/JinSSJ3/dynamicss?branch=master)
[](https://lgtm.com/projects/g/JinSSJ3/dynamicss/alerts/)
[](https://lgtm.com/projects/g/unlimited-react-components/react-drop-zone/context:javascript)
[](https://snyk.io/test/github/jinssj3/dynamicss)
[](http://makeapullrequest.com)
## Description
With DinamiCSS you can manage CSS style sheets dynamically
## Installation
DinamiCSS is available as an [npm package](https://www.npmjs.com/package/dinamicss).
```sh
// with npm
npm i @dynamicss/dynamicss
```
## Main Features:
- Insert style sheets from javascript files.
- Edit stylesheets at run-time.
- Remove style sheet.
- Check whether a style sheet has already been inserted into the DOM
- Create a DynamicSheet object rpresentation
## Usage (basic example)
Here is a quick example to get you started, **it's all you need**:
Interactive and live demo:
[](https://codesandbox.io/s/dynamicss-react-h5zie)
## DynamiCSS Types:
| Name | Description | Attributes |
| ------------------ | --------------------------------------------------------- | --------------------------------------------------------------- |
| `DynamicSheet` | Object that represents a css style sheet | `id`: string; |
| | | `content?`: string; |
| | | `sheetRules?`: DynamicSheetRule[]; |
| `DynamicSheetRule` | Object that represents a set of css rules for a classname | `className`: string; |
| | | `rules`: DynamicStyle \| DynamicPseudoNested \| DynamicHyphens; |
## DynamiCSS namespace Functions:
| Function | Description |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `function insertStyleSheet(dynamicSheet: DynamicSheet): string` | Inserts the stylesheet into the DOM |
| `function editStyleSheet(id: string, sheetRules: DynamicSheetRule[]): string` | Edits an existing stylesheet in the DOM |
| `function removeStyleSheet(id: string): string` | Removes an existing stylesheet in the DOM |
| `function existStyleSheet(id: string): boolean` | Returns true if a match is found with the given id |
| `function makeStyleSheet(styleSheet: DynamicSheet): DynamicSheet` | Returns the same DynamicSheet object (probably useless, but helps in JS) |
## License
This project is licensed under the terms of the
[MIT license](/LICENSE).