@gjsify/adwaita-icons 0.4.42 → 0.4.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# @gjsify/adwaita-icons
|
|
2
|
+
|
|
3
|
+
The Adwaita symbolic icon set as importable SVG strings for browser builds. Covers all icon categories (actions, devices, mimetypes, places, status, ui) sourced from the GNOME Adwaita icon theme, with a `toDataUri()` helper for use in CSS `mask-image` and `background-image` properties.
|
|
4
|
+
|
|
5
|
+
Part of the [gjsify](https://github.com/gjsify/gjsify) project — Node.js and Web APIs for GJS (GNOME JavaScript).
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
gjsify install @gjsify/adwaita-icons
|
|
11
|
+
|
|
12
|
+
# npm or yarn also work (e.g. adding it to an existing project):
|
|
13
|
+
npm install @gjsify/adwaita-icons
|
|
14
|
+
yarn add @gjsify/adwaita-icons
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { toDataUri } from '@gjsify/adwaita-icons/utils';
|
|
21
|
+
|
|
22
|
+
// Import icons from a specific category
|
|
23
|
+
import { folder_symbolic } from '@gjsify/adwaita-icons/places';
|
|
24
|
+
import { document_new_symbolic } from '@gjsify/adwaita-icons/actions';
|
|
25
|
+
|
|
26
|
+
// Use as a CSS data URI (for mask-image / background-image)
|
|
27
|
+
const css = `mask-image: ${toDataUri(folder_symbolic)};`;
|
|
28
|
+
|
|
29
|
+
// Or import all categories at once
|
|
30
|
+
import * as icons from '@gjsify/adwaita-icons';
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## License
|
|
34
|
+
|
|
35
|
+
LGPL-3.0-or-later AND CC-BY-SA-3.0
|