@fkui/font-default 6.23.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2021 Försäkringskassan
+
+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,52 @@
+# @fkui/font-default
+
+Innehåller den standardfont och konfiguration som Försäkringskassan använder ([Inter][inter]).
+
+[inter]: https://rsms.me/inter/
+
+## Användning
+
+För att använda standardfonten importera `@fkui/default-font` efter tema (exempelvis `@fkui/theme-default`):
+
+```diff
+ @use "@fkui/theme-default";
++@use "@fkui/font-default";
+```
+
+För att applicera CSS på en egen selector sätter du `$global: false` och använder den som en mixin istället:
+
+```scss
+@use "@fkui/font-default" with (
+    $global: false
+);
+
+.awesome-selector {
+    @include font-default.font;
+}
+```
+
+Om du inte använder Vite behöver du:
+
+1. Manuellt kopiera över filer till den katalog som innehåller dina kompilerade css-filer.
+2. Sätta `$asset-path` till en relativ sökväg från den byggda css-filen till katalogen som innehåller filerna.
+
+```diff
+ @use "@fkui/theme-default";
++@use "@fkui/font-default" with (
++  $asset-path: "./fonts"
++);
+```
+
+## Metadata
+
+Paketet levererar metadata i `@fkui/font-default/metadata.json` med följande format:
+
+```ts
+export interface Asset {
+    filename: string;
+}
+
+export declare const assets: Asset[];
+```
+
+Kan med fördel användas för att kopiera över samtliga fontfiler.

package/metadata.json

@@ -0,0 +1,7 @@
+[
+    { "filename": "Inter-Bold.woff2" },
+    { "filename": "Inter-Light.woff2" },
+    { "filename": "Inter-Medium.woff2" },
+    { "filename": "Inter-Regular.woff2" },
+    { "filename": "Inter-SemiBold.woff2" }
+]

package/metadata.json.d.ts

@@ -0,0 +1,8 @@
+export interface Asset {
+    filename: string;
+    description: string;
+}
+
+declare const assets: Asset[];
+
+export default assets;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@fkui/font-default",
+  "version": "6.23.0",
+  "description": "Försäkringskassan standardfont",
+  "keywords": [
+    "fkui",
+    "designsystem",
+    "css"
+  ],
+  "homepage": "https://designsystem.forsakringskassan.se/",
+  "bugs": "https://github.com/Forsakringskassan/designsystem/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Forsakringskassan/designsystem.git",
+    "directory": "packages/font-default"
+  },
+  "license": "MIT",
+  "author": "Försäkringskassan",
+  "sideEffects": [
+    "./src/**/*.scss"
+  ],
+  "main": "./src/font.scss",
+  "files": [
+    "assets",
+    "metadata.json",
+    "metadata.json.d.ts",
+    "src"
+  ],
+  "scripts": {
+    "build": "node build.mjs",
+    "prepack": "release-prepack --bundle --retain-scripts",
+    "postpack": "release-postpack",
+    "prepublishOnly": "release-prepublish --bundle --retain-scripts",
+    "test": "node --test"
+  },
+  "engines": {
+    "node": ">= 20",
+    "npm": ">= 7"
+  },
+  "sass": "./src/font.scss",
+  "gitHead": "fa6f480d4762eb6f01607c7fc9d9de58e2d946c0"
+}

package/src/font.scss

@@ -0,0 +1,84 @@
+$global: true !default;
+$asset-path: "" !default;
+
+@mixin font-face {
+    @if $asset-path == "" {
+        @font-face {
+            font-family: Inter;
+            font-weight: 300;
+            src: url("../fonts/Inter-Light.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 400;
+            src: url("../fonts/Inter-Regular.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 500;
+            src: url("../fonts/Inter-Medium.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 600;
+            src: url("../fonts/Inter-SemiBold.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 700;
+            src: url("../fonts/Inter-Bold.woff2") format("woff2");
+        }
+    } @else {
+        @font-face {
+            font-family: Inter;
+            font-weight: 300;
+            src: url("#{$asset-path}/Inter-Light.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 400;
+            src: url("#{$asset-path}/Inter-Regular.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 500;
+            src: url("#{$asset-path}/Inter-Medium.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 600;
+            src: url("#{$asset-path}/Inter-SemiBold.woff2") format("woff2");
+        }
+
+        @font-face {
+            font-family: Inter;
+            font-weight: 700;
+            src: url("#{$asset-path}/Inter-Bold.woff2") format("woff2");
+        }
+    }
+}
+
+@mixin font-family {
+    --f-font-family: "Inter", arial, "Helvetica Neue", sans-serif;
+    --f-font-weight-normal: 400;
+    --f-font-weight-medium: 500;
+    --f-font-weight-bold: 700;
+}
+
+@mixin font {
+    @include font-face;
+    @include font-family;
+}
+
+@if $global {
+    :root {
+        @include font;
+    }
+}

package/src/font.test.mjs

@@ -0,0 +1,34 @@
+import { it, snapshot } from "node:test";
+import { compileString } from "sass";
+
+snapshot.setDefaultSnapshotSerializers([(value) => value]);
+
+it("should compile global as default", (t) => {
+    const source = `@use "font";`;
+    const result = compileString(source, { url: import.meta.url });
+    t.assert.snapshot(result.css);
+});
+
+it("should not include any styling if global is disabled", (t) => {
+    const source = `@use "font" with ($global: false);`;
+    const result = compileString(source, { url: import.meta.url });
+    t.assert.snapshot(result.css);
+});
+
+it("should support compile with custom selector", (t) => {
+    const source = [
+        `@use "font" with ($global: false);`,
+        ``,
+        `.awesome-selector {`,
+        `  @include font.font`,
+        `}`,
+    ].join("\n");
+    const result = compileString(source, { url: import.meta.url });
+    t.assert.snapshot(result.css);
+});
+
+it("should support compile with custom asset path", (t) => {
+    const source = `@use "font" with ($asset-path: "awesome-fonts");`;
+    const result = compileString(source, { url: import.meta.url });
+    t.assert.snapshot(result.css);
+});

package/src/font.test.mjs.snapshot

@@ -0,0 +1,105 @@
+exports[`should compile global as default 1`] = `
+@font-face {
+  font-family: Inter;
+  font-weight: 300;
+  src: url("../fonts/Inter-Light.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 400;
+  src: url("../fonts/Inter-Regular.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 500;
+  src: url("../fonts/Inter-Medium.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 600;
+  src: url("../fonts/Inter-SemiBold.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 700;
+  src: url("../fonts/Inter-Bold.woff2") format("woff2");
+}
+:root {
+  --f-font-family: "Inter", arial, "Helvetica Neue", sans-serif;
+  --f-font-weight-normal: 400;
+  --f-font-weight-medium: 500;
+  --f-font-weight-bold: 700;
+}
+`;
+
+exports[`should not include any styling if global is disabled 1`] = `
+
+`;
+
+exports[`should support compile with custom asset path 1`] = `
+@font-face {
+  font-family: Inter;
+  font-weight: 300;
+  src: url("awesome-fonts/Inter-Light.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 400;
+  src: url("awesome-fonts/Inter-Regular.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 500;
+  src: url("awesome-fonts/Inter-Medium.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 600;
+  src: url("awesome-fonts/Inter-SemiBold.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 700;
+  src: url("awesome-fonts/Inter-Bold.woff2") format("woff2");
+}
+:root {
+  --f-font-family: "Inter", arial, "Helvetica Neue", sans-serif;
+  --f-font-weight-normal: 400;
+  --f-font-weight-medium: 500;
+  --f-font-weight-bold: 700;
+}
+`;
+
+exports[`should support compile with custom selector 1`] = `
+@font-face {
+  font-family: Inter;
+  font-weight: 300;
+  src: url("../fonts/Inter-Light.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 400;
+  src: url("../fonts/Inter-Regular.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 500;
+  src: url("../fonts/Inter-Medium.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 600;
+  src: url("../fonts/Inter-SemiBold.woff2") format("woff2");
+}
+@font-face {
+  font-family: Inter;
+  font-weight: 700;
+  src: url("../fonts/Inter-Bold.woff2") format("woff2");
+}
+.awesome-selector {
+  --f-font-family: "Inter", arial, "Helvetica Neue", sans-serif;
+  --f-font-weight-normal: 400;
+  --f-font-weight-medium: 500;
+  --f-font-weight-bold: 700;
+}
+`;