@nubisco/ui 1.40.0 → 1.41.0

package/dist/plugins/fonts.d.ts

@@ -1,2 +1,53 @@
-export declare const fonts: () => import("vite").Plugin<any> | import("vite").Plugin<any>[];
+import Unfonts from 'unplugin-fonts/vite';
+/**
+ * Options accepted by {@link fonts}. This is the exact option object that
+ * `unplugin-fonts` exposes, so any provider it supports (`fontsource`,
+ * `custom`, `google`, `typekit`) can be configured here.
+ */
+export type TFontsOptions = NonNullable<Parameters<typeof Unfonts>[0]>;
+/**
+ * Default font configuration for NubiscoUI.
+ *
+ * Self-hosted via the `fontsource` provider (RGPD-friendly, no third-party
+ * CDN). These are the two families declared as the library defaults in
+ * `src/styles/variables/_type.scss` (`--nb-font-family-sans` / `-mono`):
+ *
+ * - Plus Jakarta Sans: weights 400, 500, 600, 700 (sans default)
+ * - Fira Code: weights 400, 600 (mono default)
+ *
+ * Only `normal` styles are loaded. Every subset shipped by Fontsource is
+ * imported, but each `@font-face` carries a `unicode-range`, so the browser
+ * only downloads the subsets a page actually needs. `font-display: swap` is
+ * baked into the Fontsource stylesheets.
+ *
+ * Consumers must install the source packages themselves:
+ * `pnpm add -D @fontsource/plus-jakarta-sans @fontsource/fira-code`.
+ */
+export declare const DEFAULT_FONTS: TFontsOptions;
+/**
+ * Vite plugin that loads NubiscoUI's typefaces.
+ *
+ * Called with no arguments it self-hosts the library defaults (Plus Jakarta
+ * Sans + Fira Code) via Fontsource, keeping every existing consumer's output
+ * unchanged. Pass an options object to fully replace that configuration: load
+ * different families/weights, point the `custom` provider at your own woff2
+ * files, or use any other provider `unplugin-fonts` supports.
+ *
+ * @example
+ * // vite.config.ts (keep the NubiscoUI defaults)
+ * import { fonts } from '@nubisco/ui/plugins/fonts'
+ * export default defineConfig({ plugins: [fonts()] })
+ *
+ * @example
+ * // bring your own families/weights
+ * fonts({
+ *   fontsource: {
+ *     families: [
+ *       { name: 'Inter', weights: [400, 600], styles: ['normal'] },
+ *       { name: 'JetBrains Mono', weights: [400], styles: ['normal'] },
+ *     ],
+ *   },
+ * })
+ */
+export declare const fonts: (options?: TFontsOptions) => import("vite").Plugin<any> | import("vite").Plugin<any>[];
 //# sourceMappingURL=fonts.d.ts.map

package/dist/plugins/fonts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fonts.d.ts","sourceRoot":"","sources":["../../src/plugins/fonts.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK,iEAgBd,CAAA"}
+{"version":3,"file":"fonts.d.ts","sourceRoot":"","sources":["../../src/plugins/fonts.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,qBAAqB,CAAA;AAEzC;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEtE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,EAAE,aAe3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,KAAK,GAAI,UAAS,aAA6B,8DAC1C,CAAA"}

package/dist/plugins/fonts.js

@@ -1,16 +1,61 @@
 import Unfonts from 'unplugin-fonts/vite';
-export const fonts = () => Unfonts({
-    google: {
-        injectTo: 'head-prepend',
+/**
+ * Default font configuration for NubiscoUI.
+ *
+ * Self-hosted via the `fontsource` provider (RGPD-friendly, no third-party
+ * CDN). These are the two families declared as the library defaults in
+ * `src/styles/variables/_type.scss` (`--nb-font-family-sans` / `-mono`):
+ *
+ * - Plus Jakarta Sans: weights 400, 500, 600, 700 (sans default)
+ * - Fira Code: weights 400, 600 (mono default)
+ *
+ * Only `normal` styles are loaded. Every subset shipped by Fontsource is
+ * imported, but each `@font-face` carries a `unicode-range`, so the browser
+ * only downloads the subsets a page actually needs. `font-display: swap` is
+ * baked into the Fontsource stylesheets.
+ *
+ * Consumers must install the source packages themselves:
+ * `pnpm add -D @fontsource/plus-jakarta-sans @fontsource/fira-code`.
+ */
+export const DEFAULT_FONTS = {
+    fontsource: {
         families: [
             {
-                name: 'Plus+Jakarta+Sans',
-                styles: 'ital,wght@0,200..800;1,200..800',
+                name: 'Plus Jakarta Sans',
+                weights: [400, 500, 600, 700],
+                styles: ['normal'],
             },
             {
-                name: 'Fira+Code',
-                styles: 'wght@300..700',
+                name: 'Fira Code',
+                weights: [400, 600],
+                styles: ['normal'],
             },
         ],
     },
-});
+};
+/**
+ * Vite plugin that loads NubiscoUI's typefaces.
+ *
+ * Called with no arguments it self-hosts the library defaults (Plus Jakarta
+ * Sans + Fira Code) via Fontsource, keeping every existing consumer's output
+ * unchanged. Pass an options object to fully replace that configuration: load
+ * different families/weights, point the `custom` provider at your own woff2
+ * files, or use any other provider `unplugin-fonts` supports.
+ *
+ * @example
+ * // vite.config.ts (keep the NubiscoUI defaults)
+ * import { fonts } from '@nubisco/ui/plugins/fonts'
+ * export default defineConfig({ plugins: [fonts()] })
+ *
+ * @example
+ * // bring your own families/weights
+ * fonts({
+ *   fontsource: {
+ *     families: [
+ *       { name: 'Inter', weights: [400, 600], styles: ['normal'] },
+ *       { name: 'JetBrains Mono', weights: [400], styles: ['normal'] },
+ *     ],
+ *   },
+ * })
+ */
+export const fonts = (options = DEFAULT_FONTS) => Unfonts(options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nubisco/ui",
-  "version": "1.40.0",
+  "version": "1.41.0",
   "description": "Vue 3 UI component library",
   "packageManager": "pnpm@11.0.8",
   "repository": {
@@ -120,6 +120,8 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@fontsource/fira-code": "^5.2.7",
+    "@fontsource/plus-jakarta-sans": "^5.2.8",
     "@phosphor-icons/core": "^2.1.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",

package/src/plugins/fonts.ts

@@ -1,19 +1,71 @@
 import Unfonts from 'unplugin-fonts/vite'
 
-export const fonts = () =>
-  Unfonts({
-    google: {
-      injectTo: 'head-prepend',
+/**
+ * Options accepted by {@link fonts}. This is the exact option object that
+ * `unplugin-fonts` exposes, so any provider it supports (`fontsource`,
+ * `custom`, `google`, `typekit`) can be configured here.
+ */
+export type TFontsOptions = NonNullable<Parameters<typeof Unfonts>[0]>
 
-      families: [
-        {
-          name: 'Plus+Jakarta+Sans',
-          styles: 'ital,wght@0,200..800;1,200..800',
-        },
-        {
-          name: 'Fira+Code',
-          styles: 'wght@300..700',
-        },
-      ],
-    },
-  })
+/**
+ * Default font configuration for NubiscoUI.
+ *
+ * Self-hosted via the `fontsource` provider (RGPD-friendly, no third-party
+ * CDN). These are the two families declared as the library defaults in
+ * `src/styles/variables/_type.scss` (`--nb-font-family-sans` / `-mono`):
+ *
+ * - Plus Jakarta Sans: weights 400, 500, 600, 700 (sans default)
+ * - Fira Code: weights 400, 600 (mono default)
+ *
+ * Only `normal` styles are loaded. Every subset shipped by Fontsource is
+ * imported, but each `@font-face` carries a `unicode-range`, so the browser
+ * only downloads the subsets a page actually needs. `font-display: swap` is
+ * baked into the Fontsource stylesheets.
+ *
+ * Consumers must install the source packages themselves:
+ * `pnpm add -D @fontsource/plus-jakarta-sans @fontsource/fira-code`.
+ */
+export const DEFAULT_FONTS: TFontsOptions = {
+  fontsource: {
+    families: [
+      {
+        name: 'Plus Jakarta Sans',
+        weights: [400, 500, 600, 700],
+        styles: ['normal'],
+      },
+      {
+        name: 'Fira Code',
+        weights: [400, 600],
+        styles: ['normal'],
+      },
+    ],
+  },
+}
+
+/**
+ * Vite plugin that loads NubiscoUI's typefaces.
+ *
+ * Called with no arguments it self-hosts the library defaults (Plus Jakarta
+ * Sans + Fira Code) via Fontsource, keeping every existing consumer's output
+ * unchanged. Pass an options object to fully replace that configuration: load
+ * different families/weights, point the `custom` provider at your own woff2
+ * files, or use any other provider `unplugin-fonts` supports.
+ *
+ * @example
+ * // vite.config.ts (keep the NubiscoUI defaults)
+ * import { fonts } from '@nubisco/ui/plugins/fonts'
+ * export default defineConfig({ plugins: [fonts()] })
+ *
+ * @example
+ * // bring your own families/weights
+ * fonts({
+ *   fontsource: {
+ *     families: [
+ *       { name: 'Inter', weights: [400, 600], styles: ['normal'] },
+ *       { name: 'JetBrains Mono', weights: [400], styles: ['normal'] },
+ *     ],
+ *   },
+ * })
+ */
+export const fonts = (options: TFontsOptions = DEFAULT_FONTS) =>
+  Unfonts(options)