@bcgov/bc-sans - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

package.json

 {
   "name": "@bcgov/bc-sans",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The standard font for B.C. Government digital services is BC Sans. BC Sans is an open source font family, and is a modified version of Noto Sans, developed by Google. BC Sans includes modifications to support Indigenous languages in British Columbia.",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -30,3 +30,3 @@ ## BC Sans
 Embed into a root level component
-`import '@bcgov/bc-sans/css/BCSans.css'`
+`import '@bcgov/bc-sans/css/BC_Sans.css'`
 
@@ -37,3 +37,3 @@ #### Typography.js
 import Typography from 'typography';
-import '@bcgov/bc-sans/css/BCSans.css';
+import '@bcgov/bc-sans/css/BC_Sans.css';
 
@@ -43,4 +43,4 @@ const typography = new Typography({
   baseLineHeight: 1.25,
-  headerFontFamily: ['BCSans', 'Noto Sans', 'Verdana', 'Arial', 'sans-serif'],
-  bodyFontFamily: ['BCSans', 'Noto Sans', 'Verdana', 'Arial', 'sans-serif'],
+  headerFontFamily: ['BC Sans', 'Noto Sans', 'Verdana', 'Arial', 'sans-serif'],
+  bodyFontFamily: ['BC Sans', 'Noto Sans', 'Verdana', 'Arial', 'sans-serif'],
   scaleRatio: 2.074,
@@ -52,4 +52,14 @@ });
 
+### Why are there two similar CSS files in this package?
+
+For new projects, you only need to include one of the two CSS files: `css/BC_Sans.css`. Then, reference `BC Sans` in your CSS `font-family` rules.
+
+Originally, this package shipped with just `css/BCSans.css`. This file uses `BCSans` (no space) as the `font-family` name in its `@font-face` declarations. Lots of existing application code references this name. But the metadata in the font files use `BC Sans` (with a space) for the font family name. As a result, UI design tools like Figma output code using `BC Sans` from the font files. This generated code would not work directly with this package without manual intervention.
+
+`css/BC_Sans.css` uses `BC Sans` for its CSS `font-family` names. This matches the family metadata fields in the font files. Font style code generated from Figma works with `css/BC_Sans.css`. New projects should use `css/BC_Sans.css` for smoothest designer to developer hand-off. For existing projects, there is no need to switch.
+
+### Contributing
+
 Integrating it differently? [Create a pull request](https://github.com/bcgov/bc-sans/pulls) to help us build out the documentation.
 
 

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3652449

0.06%

Number of package files

17

6.25%

Lines of code

84

100%

Number of lines in readme file

62

19.23%

Number of medium supply chain risk alerts

0

-100%

No dependency changes