@trilogy-ds/assets 0.0.1-beta-4 → 0.0.1-beta.6
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 +31 -0
- package/package.json +3 -4
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
<div align='center'>
|
|
2
|
+
|
|
3
|
+
# @trilogy-ds/assets
|
|
4
|
+
|
|
5
|
+
</div>
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@trilogy-ds/assets)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
`@trilogy-ds/assets` is a direct dependency of [@trilogy-ds/react](https://www.npmjs.com/package/@trilogy-ds/react). It includes all open-source fonts and icons from [Trilogy](https://github.com/BouyguesTelecom/trilogy).
|
|
12
|
+
|
|
13
|
+
It provides to the `<Icon/>` component, the path information from the `IconPath.ts` file (which is the paths to the icons) and the `IconName` file (which is an enum for the icon names).
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
Download the package by running:
|
|
18
|
+
|
|
19
|
+
`npm install @trilogy-ds/assets`
|
|
20
|
+
|
|
21
|
+
## Scripts 💻
|
|
22
|
+
|
|
23
|
+
This package includes the following scripts using **npm**:
|
|
24
|
+
|
|
25
|
+
1. `optimise:icons`: This script uses [SVGO](https://github.com/svg/svgo) to optimize all icons in the `assets/icons/all` directory. The optimized icons are stored in `lib/icons/all`.
|
|
26
|
+
|
|
27
|
+
2. `build`: This script runs the `optimise:icons` script, compiles Typescript files, and finally, copies all fonts from `assets/fonts/` to `lib/fonts/`.
|
|
28
|
+
|
|
29
|
+
## License
|
|
30
|
+
|
|
31
|
+
This package is licensed under the ISC license.
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trilogy-ds/assets",
|
|
3
|
-
"version": "0.0.1-beta
|
|
3
|
+
"version": "0.0.1-beta.6",
|
|
4
4
|
"description": "Trilogy assets include all Open Source Fonts & Icons",
|
|
5
|
+
"author": "Bouygues Telecom",
|
|
5
6
|
"type": "module",
|
|
6
7
|
"module": "lib/index.js",
|
|
7
8
|
"files": [
|
|
@@ -9,10 +10,8 @@
|
|
|
9
10
|
],
|
|
10
11
|
"scripts": {
|
|
11
12
|
"optimise:icons": "svgo -f ./assets/icons/all -o ./lib/icons/all",
|
|
12
|
-
"build": "rimraf lib && npm run optimise:icons && tsc -p . && cp -r ./assets/fonts/ ./lib/fonts/"
|
|
13
|
-
"pack": "npm pack"
|
|
13
|
+
"build": "rimraf lib && npm run optimise:icons && tsc -p . && cp -r ./assets/fonts/ ./lib/fonts/"
|
|
14
14
|
},
|
|
15
|
-
"author": "",
|
|
16
15
|
"license": "ISC",
|
|
17
16
|
"devDependencies": {
|
|
18
17
|
"@types/node": "^20.11.26",
|