@reuters-graphics/graphics-components 0.0.1-beta.2 → 0.0.1-beta.20

package/README.md

@@ -2,6 +2,8 @@
 
 # ⚙️ graphics-components
 
+[![npm version](https://badge.fury.io/js/@reuters-graphics%2Fgraphics-components.svg)](https://badge.fury.io/js/@reuters-graphics%2Fgraphics-components)
+
 Svelte components, SCSS and more for Reuters Graphics pages.
 
 [Read the docs.](https://reuters-graphics.github.io/graphics-components/)

package/dist/@types/components/Article/Article.svelte.d.ts

@@ -27,6 +27,11 @@ declare const __propDef: {
 export declare type ArticleProps = typeof __propDef.props;
 export declare type ArticleEvents = typeof __propDef.events;
 export declare type ArticleSlots = typeof __propDef.slots;
+/**
+ * The `Article` component contains all the content of our story and also establishes the dimensions of our article well, the default central trunk of our page layout.
+ *
+ * [Docs](https://reuters-graphics.github.io/graphics-components/?path=/docs/layout-article--default)
+ */
 export default class Article extends SvelteComponentTyped<ArticleProps, ArticleEvents, ArticleSlots> {
 }
 export {};

package/dist/@types/components/SEO/SEO.svelte.d.ts

@@ -1,11 +1,17 @@
 import { SvelteComponentTyped } from "svelte";
 declare const __propDef: {
     props: {
+        /**
+           * Base url for the page, which in [Vite-based projects](https://vitejs.dev/guide/build.html#public-base-path)
+           * is globally available as `import.meta.env.BASE_URL`.
+           * @required
+           * @type {string}
+           */ baseUrl?: string;
         /**
            * [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) object for the page.
            * @required
            * @type {URL}
-           */ url?: URL | null;
+           */ pageUrl?: URL | null;
         /**
            * SEO title
            * @required

package/dist/@types/components/Scroller/docProps.d.ts

@@ -0,0 +1,32 @@
+import type { ComponentType } from 'svelte';
+interface BlockStep {
+    Background: string;
+    Text: string;
+}
+interface Block {
+    Type: string;
+    Width: string;
+    ForegroundPosition: string;
+    StackBackground?: string;
+    EmbeddedLayout?: string;
+    ID?: string;
+    Steps: BlockStep[];
+}
+interface AiCharts {
+    [key: string]: ComponentType;
+}
+export declare const getScrollerPropsFromDoc: (docBlock: Block, aiCharts: AiCharts, assetsPath?: string) => {
+    id: string;
+    backgroundWidth: string;
+    foregroundPosition: string;
+    stackBackground: boolean;
+    embeddedLayout: string;
+    steps: {
+        background: ComponentType<import("svelte").SvelteComponentTyped<any, any, any>>;
+        backgroundProps: {
+            assetsPath: string;
+        };
+        foreground: string;
+    }[];
+};
+export {};

package/dist/@types/index.d.ts

@@ -22,5 +22,6 @@ export { default as SiteHeader } from "./components/SiteHeader/SiteHeader.svelte
 export { default as Spinner } from "./components/Spinner/Spinner.svelte";
 export { default as Video } from "./components/Video/Video.svelte";
 export { default as Visible } from "./components/Visible/Visible.svelte";
-export { getPhotoPackPropsFromDoc } from "./components/PhotoPack/docProps";
+export { getPhotoPackPropsFromDoc } from "./components/PhotoPack/docProps.js";
+export { getScrollerPropsFromDoc } from "./components/Scroller/docProps.js";
 export { default as Theme, themes } from "./components/Theme/Theme.svelte";

package/dist/components/Article/Article.svelte

@@ -1,3 +1,8 @@
+<!-- 
+  @component The `Article` component contains all the content of our story and also establishes the dimensions of our article well, the default central trunk of our page layout.
+  
+  [Docs](https://reuters-graphics.github.io/graphics-components/?path=/docs/layout-article--default)
+-->
 <script>/** Set to true for embeddables. */
 export let embedded = false;
 /** Add an id to the article tag to target it with custom CSS. */
@@ -12,7 +17,7 @@ export let columnWidths = {
     wide: 930,
     wider: 1200,
 };
-import cssVariables from '$lib/actions/cssVariables/index.js';
+import cssVariables from '../../actions/cssVariables/index.js';
 $: columnWidthVars = {
     'narrower-column-width': columnWidths.narrower + 'px',
     'narrow-column-width': columnWidths.narrow + 'px',

package/dist/components/NoteText/NoteText.svelte

@@ -8,7 +8,7 @@ import { marked } from 'marked';
 import Block from '../Block/Block.svelte';
 </script>
 
-<Block cls="notes">
+<Block cls="notes mb-6">
   {#if text}
     {@html marked.parse(text)}
   {/if}

package/dist/components/SEO/SEO.svelte

@@ -1,11 +1,18 @@
 <script>import analytics from './analytics';
 import publisherTags from './publisherTags';
+/**
+ * Base url for the page, which in [Vite-based projects](https://vitejs.dev/guide/build.html#public-base-path)
+ * is globally available as `import.meta.env.BASE_URL`.
+ * @required
+ * @type {string}
+ */
+export let baseUrl = '';
 /**
  * [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) object for the page.
  * @required
  * @type {URL}
  */
-export let url = null;
+export let pageUrl = null;
 /**
  * SEO title
  * @required
@@ -59,9 +66,23 @@ export let authors = [];
  * Whether to inject Google Analytics code for this page.
  */
 export let includeAnalytics = false;
+const getOrigin = (baseUrl) => {
+    try {
+        return new URL(baseUrl).origin;
+    }
+    catch {
+        // This handles a weird case where Vite's base path is
+        // reset to './' after the app hydrates...
+        if (typeof window !== 'undefined')
+            return getOrigin(window.location.href);
+        return '';
+    }
+};
+$: origin = getOrigin(baseUrl);
+$: canonicalUrl = origin + pageUrl.pathname;
 // Only fire analytics on prod sites
 if (typeof window !== 'undefined' && includeAnalytics) {
-    analytics(url, seoTitle);
+    analytics(canonicalUrl, seoTitle);
     publisherTags();
 }
 const orgLdJson = {
@@ -81,10 +102,10 @@ const articleLdJson = {
     '@context': 'http://schema.org',
     '@type': 'NewsArticle',
     headline: seoTitle,
-    url: url.href,
+    url: canonicalUrl,
     mainEntityOfPage: {
         '@type': 'WebPage',
-        '@id': url.href,
+        '@id': canonicalUrl,
     },
     thumbnailUrl: shareImgPath,
     image: [
@@ -117,7 +138,7 @@ const articleLdJson = {
   <html lang="{lang}"></html>
   <title>{seoTitle}</title>
   <meta name="description" content="{seoDescription}" />
-  <link rel="canonical" href="{url.href}" />
+  <link rel="canonical" href="{canonicalUrl}" />
   <link
     rel="shortcut icon"
     type="image/x-icon"
@@ -142,7 +163,7 @@ const articleLdJson = {
     sizes="96x96"
   />
 
-  <meta property="og:url" content="{url.href}" />
+  <meta property="og:url" content="{canonicalUrl}" />
   <meta property="og:type" content="article" />
   <meta property="og:title" content="{shareTitle}" itemprop="name" />
   <meta
@@ -150,17 +171,13 @@ const articleLdJson = {
     content="{shareDescription}"
     itemprop="description"
   />
-  <meta
-    property="og:image"
-    content="{shareImgPath}"
-    itemprop="image"
-  />
+  <meta property="og:image" content="{shareImgPath}" itemprop="image" />
   <meta property="og:site_name" content="Reuters" />
 
   <meta name="twitter:card" content="summary_large_image" />
   <meta name="twitter:site" content="@ReutersGraphics" />
   <meta name="twitter:creator" content="@ReutersGraphics" />
-  <meta name="twitter:domain" content="{url.origin}" />
+  <meta name="twitter:domain" content="{origin}" />
   <meta name="twitter:title" content="{shareTitle}" />
   <meta name="twitter:description" content="{shareDescription}" />
   <meta name="twitter:image:src" content="{shareImgPath}" />

package/dist/components/Scroller/docProps.js

@@ -0,0 +1,14 @@
+export const getScrollerPropsFromDoc = (docBlock, aiCharts, assetsPath = '') => {
+    return {
+        id: docBlock.ID,
+        backgroundWidth: docBlock.Width,
+        foregroundPosition: docBlock.ForegroundPosition,
+        stackBackground: docBlock.StackBackground === 'true' || !docBlock.StackBackground,
+        embeddedLayout: docBlock.EmbeddedLayout,
+        steps: docBlock.Steps.map((step) => ({
+            background: aiCharts[step.Background],
+            backgroundProps: { assetsPath },
+            foreground: step.Text,
+        })),
+    };
+};

package/dist/components/SiteFooter/SiteFooter.svelte

@@ -10,6 +10,7 @@ export let referrals = [];
 </script>
 
 <footer
+  class="my-0"
   style="{`
     --nav-background: var(--theme-colour-background, #fff);
     --nav-primary: var(--theme-colour-text-primary, #404040);
@@ -26,7 +27,7 @@ export let referrals = [];
 
 <!-- svelte-ignore css-unused-selector -->
 <style>footer {
-  margin-top: 4rem;
+  margin-top: 0;
   background-color: var(--nav-background, #fff);
 }
 footer div {

package/dist/components/SiteHeader/MobileMenu/index.svelte

@@ -1,5 +1,5 @@
 <script>
-  import { ReutersLogo } from '../../../index.js';
+  import ReutersLogo from '../../ReutersLogo/ReutersLogo.svelte';
   import CloseIcon from '../svgs/Close.svelte';
   import { normalizeUrl } from '../NavBar/utils/index.js';
 

package/dist/components/SiteHeader/SiteHeader.svelte

@@ -1,4 +1,4 @@
-<script>import { ReutersLogo } from '../../index.js';
+<script>import ReutersLogo from '../ReutersLogo/ReutersLogo.svelte';
 import NavBar from './NavBar/index.svelte';
 import data from './data.json';
 import { setContext } from 'svelte';

package/dist/components/Theme/Theme.svelte

@@ -17,18 +17,16 @@ export let theme = {};
  * explicitly set.
  */
 export let base = 'light';
-import cssVariables from '../../actions/cssVariables';
 import flatten from './utils/flatten';
 import mergeThemes from './utils/merge';
 /** @type {Theme} */
 $: mergedTheme = mergeThemes({}, themes[base] || themes.light, theme);
+$: cssVariables = Object.entries(flatten({ theme: mergedTheme }))
+    .map(([key, value]) => `--${key}: ${value};`)
+    .join(' ');
 </script>
 
-<div
-  class="theme"
-  style="display: contents;"
-  use:cssVariables="{flatten({ theme: mergedTheme })}"
->
+<div class="theme" style="{cssVariables}" style:display="contents">
   <!-- Clients can override the theme above by attaching custom properties to this element. -->
   <div class="theme-client-override" style="display: contents;">
     <!-- Themed content -->

package/dist/components/Theme/themes/dark.js

@@ -5,8 +5,8 @@ export default {
     'text-primary': '#ffffff',
     'text-secondary': 'rgb(255 255 255 / 60%)',
     accent: ' #ef3c2a',
-    'brand-logo': '#fa6400',
-    'brand-rules': '#999999',
+    'brand-logo': '#ffffff',
+    'brand-rules': 'rgb(255 255 255 / 25%)',
     'brand-shadow': 'rgb(255 255 255 / 10%)',
   },
   font: {

package/dist/index.js

@@ -30,4 +30,5 @@ export { default as Video } from './components/Video/Video.svelte';
 export { default as Visible } from './components/Visible/Visible.svelte';
 
 // Utilities
-export { getPhotoPackPropsFromDoc } from './components/PhotoPack/docProps';
+export { getPhotoPackPropsFromDoc } from './components/PhotoPack/docProps.js';
+export { getScrollerPropsFromDoc } from './components/Scroller/docProps.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reuters-graphics/graphics-components",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.20",
   "type": "module",
   "private": false,
   "homepage": "https://reuters-graphics.github.io/graphics-components",
@@ -11,10 +11,11 @@
     "build:package": "node ./bin/buildPackage/index.js",
     "build:docs": "build-storybook -o docs && touch ./docs/.nojekyll",
     "build": "npm-run-all build:package build:docs",
-    "prepublishOnly": "npm run build:package"
+    "prepublishOnly": "npm run build:package",
+    "postversion": "git push origin && git push origin --tags"
   },
   "license": "MIT",
-  "types": "dist/@types/index.d.ts",
+  "types": "./dist/@types/index.d.ts",
   "files": [
     "dist"
   ],
@@ -126,6 +127,7 @@
     "./components/Scroller/Embedded/index.svelte": "./dist/components/Scroller/Embedded/index.svelte",
     "./components/Scroller/Foreground.svelte": "./dist/components/Scroller/Foreground.svelte",
     "./components/Scroller/Scroller.svelte": "./dist/components/Scroller/Scroller.svelte",
+    "./components/Scroller/docProps.ts": "./dist/components/Scroller/docProps.ts",
     "./components/Sharer/Sharer.svelte": "./dist/components/Sharer/Sharer.svelte",
     "./components/Sharer/utils/copyToClipboard": "./dist/components/Sharer/utils/copyToClipboard.js",
     "./components/Sharer/utils/facebook": "./dist/components/Sharer/utils/facebook.js",
@@ -160,11 +162,11 @@
     "./components/SiteHeader/NavBar/utils": "./dist/components/SiteHeader/NavBar/utils/index.js",
     "./components/SiteHeader/SiteHeader.svelte": "./dist/components/SiteHeader/SiteHeader.svelte",
     "./components/SiteHeader/data.json": "./dist/components/SiteHeader/data.json",
-    "./components/SiteHeader/scss/_breakpoints.scss": "./dist/components/SiteHeader/scss/_breakpoints.scss",
-    "./components/SiteHeader/scss/_colors.scss": "./dist/components/SiteHeader/scss/_colors.scss",
-    "./components/SiteHeader/scss/_eases.scss": "./dist/components/SiteHeader/scss/_eases.scss",
-    "./components/SiteHeader/scss/_grids.scss": "./dist/components/SiteHeader/scss/_grids.scss",
-    "./components/SiteHeader/scss/_z-indexes.scss": "./dist/components/SiteHeader/scss/_z-indexes.scss",
+    "./components/SiteHeader/scss/breakpoints": "./dist/components/SiteHeader/scss/_breakpoints.scss",
+    "./components/SiteHeader/scss/colors": "./dist/components/SiteHeader/scss/_colors.scss",
+    "./components/SiteHeader/scss/eases": "./dist/components/SiteHeader/scss/_eases.scss",
+    "./components/SiteHeader/scss/grids": "./dist/components/SiteHeader/scss/_grids.scss",
+    "./components/SiteHeader/scss/z-indexes": "./dist/components/SiteHeader/scss/_z-indexes.scss",
     "./components/SiteHeader/svgs/Close.svelte": "./dist/components/SiteHeader/svgs/Close.svelte",
     "./components/SiteHeader/svgs/Menu.svelte": "./dist/components/SiteHeader/svgs/Menu.svelte",
     "./components/Spinner/Spinner.svelte": "./dist/components/Spinner/Spinner.svelte",
@@ -177,34 +179,35 @@
     "./components/Video/Controls.svelte": "./dist/components/Video/Controls.svelte",
     "./components/Video/Video.svelte": "./dist/components/Video/Video.svelte",
     "./components/Visible/Visible.svelte": "./dist/components/Visible/Visible.svelte",
-    "./scss/_mixins.scss": "./dist/scss/_mixins.scss",
-    "./scss/_variables.scss": "./dist/scss/_variables.scss",
-    "./scss/bootstrap/_main.scss": "./dist/scss/bootstrap/_main.scss",
-    "./scss/bootstrap/_variables.scss": "./dist/scss/bootstrap/_variables.scss",
-    "./scss/colours/thematic/_nord.scss": "./dist/scss/colours/thematic/_nord.scss",
-    "./scss/colours/thematic/_tr.scss": "./dist/scss/colours/thematic/_tr.scss",
-    "./scss/components/_hero-title.scss": "./dist/scss/components/_hero-title.scss",
-    "./scss/fonts/_font-faces.scss": "./dist/scss/fonts/_font-faces.scss",
-    "./scss/fonts/_mixins.scss": "./dist/scss/fonts/_mixins.scss",
-    "./scss/fonts/_rules.scss": "./dist/scss/fonts/_rules.scss",
-    "./scss/fonts/_variables.scss": "./dist/scss/fonts/_variables.scss",
-    "./scss/main.scss": "./dist/scss/main.scss",
-    "./scss/mixins/_block.scss": "./dist/scss/mixins/_block.scss",
-    "./scss/mixins/_body-text.scss": "./dist/scss/mixins/_body-text.scss",
-    "./scss/mixins/_graphic.scss": "./dist/scss/mixins/_graphic.scss",
-    "./scss/mixins/_note-text.scss": "./dist/scss/mixins/_note-text.scss",
-    "./scss/mixins/_visually-hidden.scss": "./dist/scss/mixins/_visually-hidden.scss",
-    "./scss/spacers/_rules.scss": "./dist/scss/spacers/_rules.scss",
-    "./scss/spacers/_variables.scss": "./dist/scss/spacers/_variables.scss",
-    "./scss/typography/_box-shadow.scss": "./dist/scss/typography/_box-shadow.scss",
-    "./scss/typography/_font-size.scss": "./dist/scss/typography/_font-size.scss",
-    "./scss/typography/_letter-spacing.scss": "./dist/scss/typography/_letter-spacing.scss",
-    "./scss/typography/_main.scss": "./dist/scss/typography/_main.scss",
-    "./scss/typography/_mixins.scss": "./dist/scss/typography/_mixins.scss",
-    "./scss/typography/_rules.scss": "./dist/scss/typography/_rules.scss",
-    "./scss/typography/_text-shadow.scss": "./dist/scss/typography/_text-shadow.scss",
-    "./scss/typography/_transform.scss": "./dist/scss/typography/_transform.scss",
-    "./scss/typography/_variables.scss": "./dist/scss/typography/_variables.scss",
+    "./scss/mixins": "./dist/scss/_mixins.scss",
+    "./scss/variables": "./dist/scss/_variables.scss",
+    "./scss/bootstrap/main": "./dist/scss/bootstrap/_main.scss",
+    "./scss/bootstrap/variables": "./dist/scss/bootstrap/_variables.scss",
+    "./scss/colours/thematic/nord": "./dist/scss/colours/thematic/_nord.scss",
+    "./scss/colours/thematic/tr": "./dist/scss/colours/thematic/_tr.scss",
+    "./scss/components/hero-title": "./dist/scss/components/_hero-title.scss",
+    "./scss/fonts/font-faces": "./dist/scss/fonts/_font-faces.scss",
+    "./scss/fonts/mixins": "./dist/scss/fonts/_mixins.scss",
+    "./scss/fonts/rules": "./dist/scss/fonts/_rules.scss",
+    "./scss/fonts/variables": "./dist/scss/fonts/_variables.scss",
+    "./scss/main": "./dist/scss/main.scss",
+    "./scss/mixins/block": "./dist/scss/mixins/_block.scss",
+    "./scss/mixins/body-text": "./dist/scss/mixins/_body-text.scss",
+    "./scss/mixins/graphic": "./dist/scss/mixins/_graphic.scss",
+    "./scss/mixins/note-text": "./dist/scss/mixins/_note-text.scss",
+    "./scss/mixins/visually-hidden": "./dist/scss/mixins/_visually-hidden.scss",
+    "./scss/spacers/rules": "./dist/scss/spacers/_rules.scss",
+    "./scss/spacers/variables": "./dist/scss/spacers/_variables.scss",
+    "./scss/typography/box-shadow": "./dist/scss/typography/_box-shadow.scss",
+    "./scss/typography/font-size": "./dist/scss/typography/_font-size.scss",
+    "./scss/typography/letter-spacing": "./dist/scss/typography/_letter-spacing.scss",
+    "./scss/typography/main": "./dist/scss/typography/_main.scss",
+    "./scss/typography/mixins": "./dist/scss/typography/_mixins.scss",
+    "./scss/typography/rules": "./dist/scss/typography/_rules.scss",
+    "./scss/typography/text-shadow": "./dist/scss/typography/_text-shadow.scss",
+    "./scss/typography/transform": "./dist/scss/typography/_transform.scss",
+    "./scss/typography/variables": "./dist/scss/typography/_variables.scss",
     ".": "./dist/index.js"
-  }
+  },
+  "svelte": "./dist/index.js"
 }