@nice-digital/nds-core 4.0.2 → 4.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nice-digital/nds-core",
-	"version": "4.0.2",
+	"version": "4.0.4",
 	"description": "Core code for the NICE Design System",
 	"author": "Ian Routledge <ian.routledge@nice.org.uk>",
 	"contributors": [
@@ -10,6 +10,7 @@
 	"homepage": "https://design-system.nice.org.uk/",
 	"license": "MIT",
 	"main": "es/core.js",
+	"types": "es/core.d.ts",
 	"style": "scss/core.scss",
 	"directories": {
 		"lib": "es"
@@ -31,7 +32,7 @@
 		"url": "https://github.com/nice-digital/nice-design-system/issues"
 	},
 	"dependencies": {
-		"@nice-digital/icons": "^6.0.0-alpha.0",
+		"@nice-digital/icons": "^6.0.0",
 		"sass-mq": "^6.0.0"
 	},
 	"peerDependencies": {
@@ -46,5 +47,5 @@
 		"@types/node": "^18.11.9",
 		"typescript": "^4.8.4"
 	},
-	"gitHead": "d8feb7beba5fffa49da42d6a550cb8f67a50727d"
+	"gitHead": "c8db07e6492c3b18564bd4f46c2ab098f185109a"
 }

package/scss/typography/_settings.scss

@@ -18,18 +18,6 @@ $base-line-height: 1.6;
 /// @since 3.0.0
 $link-hover-text-decoration-thickness: 0.1rem;
 
-/// Sans-serif font stack
-/// @since 2.0.0
-$font-family-sans: 'Inter, Roboto, "Segoe UI", "Helvetica Neue", Helvetica, Arial, sans-serif';
-
-/// Serif font stack
-/// @since 2.0.0
-$font-family-serif: 'Lora, Georgia, Times, serif';
-
-/// Mono font stack
-/// @since 0.2.0
-$font-family-mono: 'Monaco, Menlo, Consolas, "Courier New", monospace';
-
 /// The font families in use across NICE.
 /// @prop {Font stack} sans [Inter, Helvetica Neue, Helvetica, Arial, sans-serif] The sans-serif font stack
 /// @prop {Font stack} serif [Lora, Georgia, Times, serif] The serif font stack
@@ -37,9 +25,9 @@ $font-family-mono: 'Monaco, Menlo, Consolas, "Courier New", monospace';
 /// @see font-family
 /// @since 0.2.0
 $font-families: (
-  sans: $font-family-sans,
-  serif: $font-family-serif,
-  mono: $font-family-mono
+  sans: var(--sans-font-family),
+  serif: var(--serif-font-family),
+  mono: var(--mono-font-family)
 );
 
 /// The modular scale ratio to use for typography

package/es/breakpoints.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"breakpoints.js","names":["breakpoints","xs","sm","md","lg","xl","matchesFrom","breakpointName","breakpointPx","Error","window","matchMedia","matches"],"sources":["../src/breakpoints.js"],"sourcesContent":["/**\n * @module Breakpoints\n */\n\n/**\n * The breakpoints, in pixel values.\n * These correspond with the breakpoints defined in SASS.\n * Often not used directly, but via matchesFrom.\n */\nexport const breakpoints = {\n\txs: 400,\n\tsm: 600,\n\tmd: 900,\n\tlg: 1200,\n\txl: 1600\n};\n\n/**\n * Determines if the device's width matches a min-width query from the given breakpoint.\n *\n * @param {string} breakpointName The breakpoint name\n * @return {Boolean} True if it matches, false otherwise.\n *\n * @example\n * \timport { matchesFrom } from \"./breakpoints\";\n * \t// Checks if the media query (min-width: 25em) matches\n * \tvar matches = matchesFrom(\"xs\");\n */\nexport const matchesFrom = (breakpointName) => {\n\tlet breakpointPx = breakpoints[breakpointName];\n\n\tif (!breakpointPx) {\n\t\tthrow new Error(`Breakpoint ${breakpointName} does not exist`);\n\t}\n\n\t// Assume matchMedia is polyfilled elsewhere\n\t// Convert to ems to match the media query if the browser's root font-size isn't 16\n\treturn window.matchMedia(`(min-width: ${breakpointPx / 16}em)`).matches;\n};\n"],"mappings":"AAAA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,WAAW,GAAG;EAC1BC,EAAE,EAAE,GADsB;EAE1BC,EAAE,EAAE,GAFsB;EAG1BC,EAAE,EAAE,GAHsB;EAI1BC,EAAE,EAAE,IAJsB;EAK1BC,EAAE,EAAE;AALsB,CAApB;AAQP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,IAAMC,WAAW,GAAG,SAAdA,WAAc,CAACC,cAAD,EAAoB;EAC9C,IAAIC,YAAY,GAAGR,WAAW,CAACO,cAAD,CAA9B;;EAEA,IAAI,CAACC,YAAL,EAAmB;IAClB,MAAM,IAAIC,KAAJ,iBAAwBF,cAAxB,qBAAN;EACA,CAL6C,CAO9C;EACA;;;EACA,OAAOG,MAAM,CAACC,UAAP,kBAAiCH,YAAY,GAAG,EAAhD,UAAyDI,OAAhE;AACA,CAVM"}

package/es/core.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"core.js","names":[],"sources":["../src/core.js"],"sourcesContent":["export * from \"./utils\";\nexport * from \"./breakpoints\";\n"],"mappings":"AAAA,cAAc,SAAd;AACA,cAAc,eAAd"}

package/es/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","names":["trim","str","replace","throttle","fn","threshhold","scope","last","deferTimer","throttled","context","now","Date","args","arguments","clearTimeout","setTimeout","apply","debounce","func","execAsap","threshold","timeout","debounced","delayed","slugify","toLowerCase","nextUniqueId","i","prefix","camelCase","split","join","letter","index","toUpperCase"],"sources":["../src/utils.js"],"sourcesContent":["/**\n * @module Utils\n * Utility functions\n */\n\n/**\n * Trims whitespace characters from the start and end of a string.\n * This utility method exists because String.prototype.trim is\n * not supported in IE8.\n *\n * @param {string} str The string to trim\n */\nexport const trim = function (str) {\n\treturn str.replace(/^[\\s\\uFEFF\\xA0]+|[\\s\\uFEFF\\xA0]+$/g, \"\");\n};\n\n/**\n * Throttle events\n * See https://remysharp.com/2010/07/21/throttling-function-calls\n *\n * @param      {Function}  func       The function to throttle\n * @param      {Integer}  threshold  The threshhold period, in milliseconds\n * @param      {Object}  scope   The context of the throttled function\n * @return     {Function}  { The throttled function }\n */\nexport const throttle = function (fn, threshhold = 100, scope = null) {\n\tlet last, deferTimer;\n\n\treturn function throttled() {\n\t\tlet context = scope || this,\n\t\t\tnow = +new Date(),\n\t\t\targs = arguments;\n\n\t\tif (last && now < last + threshhold) {\n\t\t\t// hold on to it\n\t\t\tclearTimeout(deferTimer);\n\t\t\tdeferTimer = setTimeout(function () {\n\t\t\t\tlast = now;\n\t\t\t\tfn.apply(context, args);\n\t\t\t}, threshhold);\n\t\t} else {\n\t\t\tlast = now;\n\t\t\tfn.apply(context, args);\n\t\t}\n\t};\n};\n\n/**\n * Debounce\n * See http://unscriptable.com/2009/03/20/debouncing-javascript-methods/\n *\n * @param      {Function}  func       The function to debounce\n * @param      {Integer}  execAsap   Whether to execute the function now\n * @param      {Integer}  threshold  The detection period, in milliseconds\n * @param      {Object}  scope  The context for the debounced function\n * @return     {Function}  { The debounced function }\n */\nexport const debounce = function (\n\tfunc,\n\texecAsap = false,\n\tthreshold = 100,\n\tscope = null\n) {\n\tlet timeout;\n\n\treturn function debounced() {\n\t\tlet context = scope || this,\n\t\t\targs = arguments;\n\n\t\tfunction delayed() {\n\t\t\tif (!execAsap) func.apply(context, args);\n\t\t\ttimeout = null;\n\t\t}\n\n\t\tif (timeout) clearTimeout(timeout);\n\t\telse if (execAsap) func.apply(context, args);\n\n\t\ttimeout = setTimeout(delayed, threshold);\n\t};\n};\n\n/**\n * Turns a string into a slug.\n * See {@link https://gist.github.com/mathewbyrne/1280286#gistcomment-1606270|this gist}.\n *\n * @param {string} str { The string to slugify }\n * @returns {string} { The slugified string }\n *\n * @example <caption>Example slugifying</caption>\n *          import { slugify } from \"./utils\";\n *          // returns \"a-string-to-transform-and-slugify\"\n *          slugify(\"A (string) to transform & slugify!\");\n */\nexport const slugify = (str) => {\n\treturn trim(str)\n\t\t.toLowerCase()\n\t\t.replace(/\\s+/g, \"-\") // Replace spaces with -\n\t\t.replace(/&/g, \"-and-\") // Replace & with 'and'\n\t\t.replace(/[^\\w-]+/g, \"\") // Remove all non-word chars\n\t\t.replace(/^-+/g, \"\") // Trim dashes from the start\n\t\t.replace(/-+$/g, \"\") // Trim dashes from the end\n\t\t.replace(/-{2,}/g, \"-\"); // Replace multiple - with single -\n};\n\n/**\n * Generates a unique id in the form prefix-n by incrementing a counter.\n * The first time this is called it will return \"uid-1\" then \"uid-2\" and so on.\n * See {@link http://stackoverflow.com/a/20302361|This StackOverflow answer}.\n *\n * @param {string} prefix { The prefix for the id to return. Defaults to \"uid\" }\n * @return {string} { The unique id }\n *\n * @example <caption>Simple example</caption>\n *          import { nextUniqueId } from \"./utils\";\n *          // returns \"uid-1\"\n *          nextUniqueId();\n *\n * @example <caption>Prefix example</caption>\n *          import utils from \"./utils\";\n *          // returns \"prefix-1\"\n *          utils.nextUniqueId(\"prefix\");\n */\nexport const nextUniqueId = (function (i) {\n\treturn function (prefix = \"uid\") {\n\t\treturn `${prefix}-${++i}`;\n\t};\n})(0);\n\n/**\n * CamelCases a  string\n * @param {string} str The string to camel case\n */\nexport const camelCase = function (str) {\n\tstr = str.split(\"-\").join(\" \"); // To support kebab-case\n\t// See https://stackoverflow.com/a/2970667/486434\n\treturn str\n\t\t.replace(/(?:^\\w|[A-Z]|\\b\\w)/g, function (letter, index) {\n\t\t\treturn index === 0 ? letter.toLowerCase() : letter.toUpperCase();\n\t\t})\n\t\t.replace(/\\s+/g, \"\");\n};\n\nexport default {\n\tthrottle: throttle,\n\tdebounce: debounce,\n\tslugify: slugify,\n\tnextUniqueId: nextUniqueId,\n\tcamelCase: camelCase\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,IAAI,GAAG,SAAPA,IAAO,CAAUC,GAAV,EAAe;EAClC,OAAOA,GAAG,CAACC,OAAJ,CAAY,oCAAZ,EAAkD,EAAlD,CAAP;AACA,CAFM;AAIP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,IAAMC,QAAQ,GAAG,SAAXA,QAAW,CAAUC,EAAV,EAAcC,UAAd,EAAgCC,KAAhC,EAA8C;EAAA,IAAhCD,UAAgC;IAAhCA,UAAgC,GAAnB,GAAmB;EAAA;;EAAA,IAAdC,KAAc;IAAdA,KAAc,GAAN,IAAM;EAAA;;EACrE,IAAIC,IAAJ,EAAUC,UAAV;EAEA,OAAO,SAASC,SAAT,GAAqB;IAC3B,IAAIC,OAAO,GAAGJ,KAAK,IAAI,IAAvB;IAAA,IACCK,GAAG,GAAG,CAAC,IAAIC,IAAJ,EADR;IAAA,IAECC,IAAI,GAAGC,SAFR;;IAIA,IAAIP,IAAI,IAAII,GAAG,GAAGJ,IAAI,GAAGF,UAAzB,EAAqC;MACpC;MACAU,YAAY,CAACP,UAAD,CAAZ;MACAA,UAAU,GAAGQ,UAAU,CAAC,YAAY;QACnCT,IAAI,GAAGI,GAAP;QACAP,EAAE,CAACa,KAAH,CAASP,OAAT,EAAkBG,IAAlB;MACA,CAHsB,EAGpBR,UAHoB,CAAvB;IAIA,CAPD,MAOO;MACNE,IAAI,GAAGI,GAAP;MACAP,EAAE,CAACa,KAAH,CAASP,OAAT,EAAkBG,IAAlB;IACA;EACD,CAhBD;AAiBA,CApBM;AAsBP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,IAAMK,QAAQ,GAAG,SAAXA,QAAW,CACvBC,IADuB,EAEvBC,QAFuB,EAGvBC,SAHuB,EAIvBf,KAJuB,EAKtB;EAAA,IAHDc,QAGC;IAHDA,QAGC,GAHU,KAGV;EAAA;;EAAA,IAFDC,SAEC;IAFDA,SAEC,GAFW,GAEX;EAAA;;EAAA,IADDf,KACC;IADDA,KACC,GADO,IACP;EAAA;;EACD,IAAIgB,OAAJ;EAEA,OAAO,SAASC,SAAT,GAAqB;IAC3B,IAAIb,OAAO,GAAGJ,KAAK,IAAI,IAAvB;IAAA,IACCO,IAAI,GAAGC,SADR;;IAGA,SAASU,OAAT,GAAmB;MAClB,IAAI,CAACJ,QAAL,EAAeD,IAAI,CAACF,KAAL,CAAWP,OAAX,EAAoBG,IAApB;MACfS,OAAO,GAAG,IAAV;IACA;;IAED,IAAIA,OAAJ,EAAaP,YAAY,CAACO,OAAD,CAAZ,CAAb,KACK,IAAIF,QAAJ,EAAcD,IAAI,CAACF,KAAL,CAAWP,OAAX,EAAoBG,IAApB;IAEnBS,OAAO,GAAGN,UAAU,CAACQ,OAAD,EAAUH,SAAV,CAApB;EACA,CAbD;AAcA,CAtBM;AAwBP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,IAAMI,OAAO,GAAG,SAAVA,OAAU,CAACxB,GAAD,EAAS;EAC/B,OAAOD,IAAI,CAACC,GAAD,CAAJ,CACLyB,WADK,GAELxB,OAFK,CAEG,MAFH,EAEW,GAFX,EAEgB;EAFhB,CAGLA,OAHK,CAGG,IAHH,EAGS,OAHT,EAGkB;EAHlB,CAILA,OAJK,CAIG,UAJH,EAIe,EAJf,EAImB;EAJnB,CAKLA,OALK,CAKG,MALH,EAKW,EALX,EAKe;EALf,CAMLA,OANK,CAMG,MANH,EAMW,EANX,EAMe;EANf,CAOLA,OAPK,CAOG,QAPH,EAOa,GAPb,CAAP,CAD+B,CAQL;AAC1B,CATM;AAWP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,IAAMyB,YAAY,GAAI,UAAUC,CAAV,EAAa;EACzC,OAAO,UAAUC,MAAV,EAA0B;IAAA,IAAhBA,MAAgB;MAAhBA,MAAgB,GAAP,KAAO;IAAA;;IAChC,OAAUA,MAAV,SAAoB,EAAED,CAAtB;EACA,CAFD;AAGA,CAJ2B,CAIzB,CAJyB,CAArB;AAMP;AACA;AACA;AACA;;AACA,OAAO,IAAME,SAAS,GAAG,SAAZA,SAAY,CAAU7B,GAAV,EAAe;EACvCA,GAAG,GAAGA,GAAG,CAAC8B,KAAJ,CAAU,GAAV,EAAeC,IAAf,CAAoB,GAApB,CAAN,CADuC,CACP;EAChC;;EACA,OAAO/B,GAAG,CACRC,OADK,CACG,qBADH,EAC0B,UAAU+B,MAAV,EAAkBC,KAAlB,EAAyB;IACxD,OAAOA,KAAK,KAAK,CAAV,GAAcD,MAAM,CAACP,WAAP,EAAd,GAAqCO,MAAM,CAACE,WAAP,EAA5C;EACA,CAHK,EAILjC,OAJK,CAIG,MAJH,EAIW,EAJX,CAAP;AAKA,CARM;AAUP,eAAe;EACdC,QAAQ,EAAEA,QADI;EAEde,QAAQ,EAAEA,QAFI;EAGdO,OAAO,EAAEA,OAHK;EAIdE,YAAY,EAAEA,YAJA;EAKdG,SAAS,EAAEA;AALG,CAAf"}