@onsvisual/svelte-components 0.1.47 → 0.1.48

package/README.md

@@ -2,11 +2,23 @@
 
 [![npm version](https://badge.fury.io/js/@onsvisual%2Fsvelte-components.svg)](https://www.npmjs.com/package/@onsvisual/svelte-components)
 
-A library of ONS Svelte components for projects large and small. Its codebase and docs borrow **heavily** from Reuters' fantastic [graphics-components](https://github.com/reuters-graphics/graphics-components) library.
-
-To update
-1. Increment version in package.json
-2. npm run build
-3. Commit + push changes to github.
-4. npm run deploy
-5. npm publish
+A library of ONS Svelte components for projects large and small. You can find documentation and examples of how to use these components on the [Storybook pages](https://onsvisual.github.io/svelte-components).
+
+This component library is inspired by Reuters' fantastic [graphics-components](https://github.com/reuters-graphics/graphics-components) library. The components are adapted from the [ONS Design System](https://service-manual.ons.gov.uk/design-system/).
+
+**To update the components:**
+
+1. Make changes to components
+2. Commit changes locally (describe your changes in the commit message)
+3. Increment version number in package.json
+4. ```npm run build``` (build the package + docs)
+5. Commit + push changes to GitHub (use version number eg. "v1.0.0" as commit message)
+6. ```npm run deploy``` (publish docs to GitHub Pages)
+7. ```npm publish``` (publish new version to NPM)
+
+**To update the docs only:**
+
+1. Update story files (.stories.svelte .stories.mdx etc)
+2. Commit + push changes to GitHub
+3. ```npm run build:docs``` (build the docs)
+4. ```npm run deploy``` (publish docs to GitHub Pages)

package/dist/@types/js/utils.d.ts

@@ -1,4 +1,5 @@
 export function slugify(str: any, suffix?: boolean): string;
+export function isNumeric(val: any): boolean;
 export function validDate(str: any): boolean;
 export function formatDate(str: any, locale?: string, opts?: {
     year: string;

package/dist/datavis/Table/Table.svelte

@@ -1,5 +1,5 @@
 <script>
-  import { format, ascending, descending } from "../../js/utils.js";
+  import { format, isNumeric, ascending, descending } from "../../js/utils.js";
 
   /**
    * An optional title for the table
@@ -126,7 +126,7 @@
               class="ons-table__cell"
               class:ons-table__cell--numeric="{col.numeric}"
               data-th="{col.label}"
-              >{@html row[col.key] && col.numeric
+              >{@html col.numeric && isNumeric(row[col.key])
                 ? format(row[col.key], col.dp)
                 : row[col.key]
                 ? row[col.key]

package/dist/js/utils.js

@@ -16,6 +16,8 @@ export const slugify = (str, suffix = false) =>
         .concat(suffix ? `-${randomString()}` : "")
     : randomString();
 
+export const isNumeric = (val) => isFinite(val) && val !== null;
+
 export const validDate = (str) => {
   if (!str) return false;
   const date = new Date(str);
@@ -34,7 +36,7 @@ export const formatDate = (
 };
 
 export const format = (val, dp = null) => {
-  return dp
+  return Number.isInteger(dp)
     ? val.toLocaleString("en-GB", {
         minimumFractionDigits: dp,
         maximumFractionDigits: dp,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onsvisual/svelte-components",
-  "version": "0.1.47",
+  "version": "0.1.48",
   "type": "module",
   "private": false,
   "homepage": "https://onsvisual.github.io/svelte-components",