@arma-events/web-fonts - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

package.json

 {
   "name": "@arma-events/web-fonts",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "type": "module",
@@ -5,0 +5,0 @@ "description": "Packaged, ready-to-use web fonts for arma.events and all related projects.",

README.md

@@ -33,1 +33,65 @@ # Web Fonts for arma.events
 ```
+
+### Advanced usage
+
+When you are using [SASS](https://sass-lang.com/) (or SCSS) you can also import the `index.scss`, which allows configuration which font families, Unicode ranges and styles should be included as well as from where the font files are loaded.
+
+<!-- prettier-ignore -->
+```scss
+// NOTE: omit the variable entirely to keep the default value
+
+@use '@arma-events/web-fonts/dist/index.scss' with (
+  // no trailing slash;
+  // would attempt to load '~my/font/files/Raleway/italic.latin.woff2'
+  //                        ^^^^^^^^^^^^^^ ^^^^^^^ ^^^^^^ ^^^^^
+  //                        Your Path      Family  Style  Range
+  $base-path: '~my/font/files',
+
+  // only include Source Sans 3 and Raleway in the italic-style
+  // and latin as well as latin-ext ranges
+  $families: ('Source Sans 3', 'Raleway'),
+  $styles: ('italic'),
+  $ranges: ('latin', 'latin-ext'),
+);
+```
+
+#### Variables
+
+> [!IMPORTANT]
+> All "Allowed Values" below might be outdated. Check the `dist/_build_info.scss` file in your package directory for the correct values.
+
+##### `$base-path`
+
+| Name           | Value                                                         |
+| :------------- | :------------------------------------------------------------ |
+| Description    | Base path of woff files to load (without a trailing slash)    |
+| Default Value  | `@arma-events/web-fonts/dist/woff2`                           |
+| Type           | [String](https://sass-lang.com/documentation/values/strings/) |
+| Allowed Values | -                                                             |
+
+##### `$families`
+
+| Name           | Value                                                            |
+| :------------- | :--------------------------------------------------------------- |
+| Description    | Font families to include                                         |
+| Default Value  | All families                                                     |
+| Type           | [List](https://sass-lang.com/documentation/values/lists/)        |
+| Allowed Values | one or multiple of `Source Sans 3`, `Source Code Pro`, `Raleway` |
+
+##### `$styles`
+
+| Name           | Value                                                     |
+| :------------- | :-------------------------------------------------------- |
+| Description    | Font styles to include                                    |
+| Default Value  | All styles                                                |
+| Type           | [List](https://sass-lang.com/documentation/values/lists/) |
+| Allowed Values | one or multiple of `normal`, `italic`                     |
+
+##### `$ranges`
+
+| Name           | Value                                                                                                   |
+| :------------- | :------------------------------------------------------------------------------------------------------ |
+| Description    | Unicode ranges to include                                                                               |
+| Default Value  | All built ranges                                                                                        |
+| Type           | [List](https://sass-lang.com/documentation/values/lists/)                                               |
+| Allowed Values | one or multiple of `cyrillic-ext`, `cyrillic`, `greek-ext`, `greek`, `vietnamese`, `latin-ext`, `latin` |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1594247

increased by0.32%

Number of lines in readme file

97

increased by193.94%

No dependency changes