56 lines
3.7 KiB
JavaScript
56 lines
3.7 KiB
JavaScript
import{M as i}from"./chunk-S4VUQJ4A-78bc21fa.js";import{p as r,j as e}from"./jsx-runtime-fdd5b7e7.js";import{u as a}from"./index-73bd681b.js";import"./iframe-6011e6c3.js";import"../sb-preview/runtime.js";import"./index-97378e4d.js";import"./_commonjsHelpers-de833af9.js";import"./index-d37d4223.js";import"./index-e04ae519.js";import"./index-356e4a49.js";function s(t){const o=Object.assign({p:"p",img:"img",h1:"h1",code:"code",pre:"pre"},a(),t.components);return e.jsxs(e.Fragment,{children:[e.jsx(i,{title:"Guides/Using with Google docs",parameters:{...r}}),`
|
|
`,e.jsx(o.p,{children:e.jsx(o.img,{src:"https://graphics.thomsonreuters.com/style-assets/images/logos/reuters-graphics-logo/svg/graphics-logo-color-dark.svg",alt:""})}),`
|
|
`,e.jsx(o.h1,{id:"using-with-google-docs",children:"Using with Google docs"}),`
|
|
`,e.jsx(o.p,{children:"Most of the default examples in these docs show how to use components by passing data into them directly through props. In the Kit, though, you likely won't be hard-coding things like text strings in your code and instead will get them from a Google Doc."}),`
|
|
`,e.jsx(o.p,{children:"It's usually easy to use a Google Doc to fill in the props for our components, but it may mean you need to write a tiny bit of code to translate strings from a doc into the data type our component's props expect."}),`
|
|
`,e.jsxs(o.p,{children:["Let's look at a basic component, a ",e.jsx(o.code,{children:"ProfileCard"}),", with a demo that looks like this in the docs:"]}),`
|
|
`,e.jsx(o.pre,{children:e.jsx(o.code,{className:"language-svelte",children:`<script>
|
|
import { ProfileCard } from '@reuters-graphics/graphics-components';
|
|
<\/script>
|
|
|
|
<ProfileCard
|
|
name="Tom"
|
|
img="https://cats.com/cat1.jpg"
|
|
birthday="{new Date('2020-09-25')}"
|
|
bio="Some notes.\\n\\nWith multiple paragraphs."
|
|
isStaff="{true}"
|
|
/>
|
|
`})}),`
|
|
`,e.jsx(o.p,{children:"The data for the component's props includes strings, a date and a boolean."}),`
|
|
`,e.jsx(o.p,{children:"In our Google doc, we might fill out a block for this component like this:"}),`
|
|
`,e.jsx(o.pre,{children:e.jsx(o.code,{className:"language-yaml",children:`Type: profile-card
|
|
Name: Tom
|
|
Image: images/tom-the-cat.jpg
|
|
Birthday: 2020-09-25
|
|
Bio: Some notes.
|
|
|
|
With multiple paragraphs.
|
|
:end
|
|
Staff: true
|
|
`})}),`
|
|
`,e.jsx(o.p,{children:"Now we can tie that data into your blocks loop like this:"}),`
|
|
`,e.jsx(o.pre,{children:e.jsx(o.code,{className:"language-svelte",children:`<script>
|
|
// These are usually already imported for you
|
|
import { assets } from '$app/paths';
|
|
import content from '$locales/en/content.json';
|
|
|
|
import { ProfileCard } from '@reuters-graphics/graphics-components';
|
|
<\/script>
|
|
|
|
{#each content.blocks as block}
|
|
<!-- ... -->
|
|
|
|
{:else if block.Type === 'profile-card'}
|
|
<ProfileCard
|
|
name="{block.Name}"
|
|
img={\`\${assets}/\${block.Image}\`}
|
|
birthday={new Date(block.Birthday)}
|
|
bio="{block.Bio}"
|
|
isStaff={block.Staff === 'true'}
|
|
/>
|
|
|
|
<!-- ... -->
|
|
{/each}
|
|
`})}),`
|
|
`,e.jsxs(o.p,{children:["Notice how we're coercing some of our data from strings into other data types: a boolean for ",e.jsx(o.code,{children:"isStaff"}),", a date for ",e.jsx(o.code,{children:"birthday"})," and an absolute path for ",e.jsx(o.code,{children:"img"}),"."]})]})}function c(t={}){const{wrapper:o}=Object.assign({},a(),t.components);return o?e.jsx(o,{...t,children:e.jsx(s,{...t})}):s(t)}const l=()=>{throw new Error("Docs-only story")};l.parameters={docsOnly:!0};const n={title:"Guides/Using with Google docs",parameters:{...r},tags:["stories-mdx"],includeStories:["__page"]};n.parameters=n.parameters||{};n.parameters.docs={...n.parameters.docs||{},page:c};const b=["__page"];export{b as __namedExportsOrder,l as __page,n as default};
|
|
//# sourceMappingURL=google-docs.stories-4e8fbd5b.js.map
|