@ukic/fonts 2.0.0-alpha.116 → 2.0.0-alpha.117

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 The Secret Intelligence Service (MI6)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# Using the UI Kit Fonts
+
+This package includes fonts used within ICDS components.
+
+## Adding a font
+
+This will add a font to the package. You shouldn't have to do this.
+
+Install the desired font from `@fontsource`:
+
+````
+npm install @fontsource/open-sans --save-dev
+````
+
+Import the package or particular font weight CSS file into `src/fonts.js`:
+
+````js
+// src/fonts.js
+import '@fontsource/open-sans/300.css';
+````
+
+Run `npm run build` and a `dist` directory will appear with the font files and main `font.css` file
+
+## Using this package
+
+Run `npm install @ukic/fonts` at the root level of your project.
+
+The `fonts.css` file can be imported:
+
+### Javascript
+
+````js
+import '@ukic/fonts/dist/fonts.css'
+````
+
+### CSS
+
+````css
+/* In some cases, reference to the node_modules directory may be required. */
+@import '@ukic/fonts/dist/fonts.css'
+````
+
+### Build
+
+Webpack is used to extract the fonts from `node_modules/@fontsource/*` directory and build the `fonts.css` file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukic/fonts",
-  "version": "2.0.0-alpha.116",
+  "version": "2.0.0-alpha.117",
   "description": "@ukic/fonts provides typography assets to ICDS components",
   "scripts": {
     "build": "rimraf ./dist && webpack --config webpack.config.js",
@@ -18,5 +18,6 @@
     "rimraf": "^3.0.2",
     "webpack": "^5.70.0",
     "webpack-cli": "^4.9.2"
-  }
+  },
+  "gitHead": "95357939ace05ebb8c86796738eb35cfc93730b6"
 }