scrupt graphics-svelte-components from docs

This commit is contained in:
Jon McClure 2022-08-16 15:33:04 +01:00
parent b47d036804
commit 14e671e81a
21 changed files with 24 additions and 22 deletions

View file

@ -6,7 +6,7 @@ Blocks are stacked vertically within the well created by the [`Article`](./?path
```svelte
<script>
import { Block } from '@reuters-graphics/graphics-svelte-components';
import { Block } from '@reuters-graphics/graphics-components';
</script>

View file

@ -2,7 +2,7 @@ Easily add a responsive Datawrapper embed on your page.
```svelte
<script>
import { DatawrapperChart } from '@reuters-graphics/graphics-svelte-components';
import { DatawrapperChart } from '@reuters-graphics/graphics-components';
</script>
<DatawrapperChart

View file

@ -2,7 +2,7 @@ An embed tool for development in graphics kit.
```svelte
<script>
import { EmbedPreviewerLink } from '@reuters-graphics/graphics-svelte-components';
import { EmbedPreviewerLink } from '@reuters-graphics/graphics-components';
import { dev } from '$app/env';
</script>

View file

@ -2,7 +2,7 @@ A full-width photo inside the text well.
```svelte
<script>
import { FeaturePhoto } from '@reuters-graphics/graphics-svelte-components';
import { FeaturePhoto } from '@reuters-graphics/graphics-components';
import { assets } from '$app/paths'; // 👈 If using in the Graphics Kit...
</script>

View file

@ -2,7 +2,7 @@ An embed tool for development in the Graphics Kit.
```svelte
<script>
import { Framer } from '@reuters-graphics/graphics-svelte-components';
import { Framer } from '@reuters-graphics/graphics-components';
const embeds = ['/embeds/my-chart/index.html'];
</script>

View file

@ -6,7 +6,7 @@ Many other components use this one to wrap graphics with styled text. When you u
```svelte
<script>
import { GraphicBlock } from '@reuters-graphics/graphics-svelte-components';
import { GraphicBlock } from '@reuters-graphics/graphics-components';
</script>

View file

@ -2,7 +2,7 @@ Reuters Graphics headline
```svelte
<script>
import { Headline } from '@reuters-graphics/graphics-svelte-components';
import { Headline } from '@reuters-graphics/graphics-components';
</script>
<Headline

View file

@ -2,7 +2,7 @@ Add a byline and dateline with `byline` and `dateline` named slots.
```svelte
<script>
import { Headline } from '@reuters-graphics/graphics-svelte-components';
import { Headline } from '@reuters-graphics/graphics-components';
</script>
<Headline

View file

@ -2,7 +2,7 @@ Add a crown image in the `crown` named slot and override the headline in the `he
```svelte
<script>
import { Headline } from '@reuters-graphics/graphics-svelte-components';
import { Headline } from '@reuters-graphics/graphics-components';
import { assets } from '$app/paths';
</script>

View file

@ -2,7 +2,7 @@ A Pym.js child instance for embeddables.
```svelte
<script>
import { PymChild } from '@reuters-graphics/graphics-svelte-components';
import { PymChild } from '@reuters-graphics/graphics-components';
</script>
<PymChild polling="{500}" />

View file

@ -2,7 +2,7 @@ The official home of the Reuters logo.
```svelte
<script>
import { ReutersLogo } from '@reuters-graphics/graphics-svelte-components';
import { ReutersLogo } from '@reuters-graphics/graphics-components';
</script>
<ReutersLogo />

View file

@ -2,7 +2,7 @@ Add share tools to a page.
```svelte
<script>
import { Sharer } from '@reuters-graphics/graphics-svelte-components';
import { Sharer } from '@reuters-graphics/graphics-components';
</script>
<Sharer />

View file

@ -4,7 +4,7 @@ Reuters dotcom site footer with graphics referrals, ported from [Raptor UI compo
```svelte
<script>
import { SiteFooter } from '@reuters-graphics/graphics-svelte-components';
import { SiteFooter } from '@reuters-graphics/graphics-components';
</script>
<SiteFooter />

View file

@ -2,7 +2,7 @@ Pass up to four custom referrals to the `referrals` prop.
```svelte
<script>
import { SiteFooter } from '@reuters-graphics/graphics-svelte-components';
import { SiteFooter } from '@reuters-graphics/graphics-components';
const customReferrals = [
{

View file

@ -15,7 +15,7 @@ The component also exports some preset themes you can use or customise:
```svelte
<script>
import { SiteFooter, SiteFooterThemes } from '@reuters-graphics/graphics-svelte-components';
import { SiteFooter, SiteFooterThemes } from '@reuters-graphics/graphics-components';
</script>
<!-- Use a preset theme. -->

View file

@ -6,7 +6,7 @@ Reuters dotcom site header, ported from [Raptor UI components](https://github.co
```svelte
<script>
import { SiteHeader } from '@reuters-graphics/graphics-svelte-components';
import { SiteHeader } from '@reuters-graphics/graphics-components';
</script>
<SiteHeader />

View file

@ -15,7 +15,7 @@ The component also exports some preset themes you can use or customise:
```svelte
<script>
import { SiteHeader, SiteHeaderThemes } from '@reuters-graphics/graphics-svelte-components';
import { SiteHeader, SiteHeaderThemes } from '@reuters-graphics/graphics-components';
</script>
<!-- Use a preset theme. -->

View file

@ -2,7 +2,7 @@ Simple loading spinner. Use it to help hide long loading times for components th
```svelte
<script>
import { Spinner } from '@reuters-graphics/graphics-svelte-components';
import { Spinner } from '@reuters-graphics/graphics-components';
let somethingsLoading = true;
</script>

View file

@ -21,7 +21,7 @@ and go to the top. Click anywhere on the page before scrolling down to the video
```svelte
<script>
import { Video } from '@reuters-graphics/graphics-svelte-components';
import { Video } from '@reuters-graphics/graphics-components';
</script>
<Video

View file

@ -1,12 +1,12 @@
Wrap components or other HTML elements to determine if they are visible on the page using the [Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API).
This is especially useful for lazy loading elements, especially expensive ones that load in big media files or components that have to fetch lots of data. You can also use it trigger animations or play media once a reader scrolls a component into view.
This is especially useful for lazy loading elements, especially expensive media files or components that fetch lots of data. You can also use it trigger animations or play media once a reader scrolls a component into view.
> **Pro tip:** Don't use this for content that's "above the fold" at the top of the page. That'll just slow down the first load of important visible content.
```svelte
<script>
import { Visible } from '@reuters-graphics/graphics-svelte-components';
import { Visible } from '@reuters-graphics/graphics-components';
</script>
<Visible let:visible>

View file

@ -7,4 +7,6 @@ import { parameters } from '$docs/utils/docsPage.js';
# Components
The components in this section can be used in any Svelte-based project. Check out the Guides section for more info on how to read the docs and use the components.
The components in this section represent the components you're most likely to use when you make your page. They can be used in any Svelte-based project, but many of the demos are specifically written for use in the Graphics Kit.
If you haven't already, check out the Guides section for more info on how to read the docs and use these components before you dive in.