npm - @datocms/svelte - Versions diffs - 0.0.1 - Mend

@datocms/svelte 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2023 DatoCMS
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,51 @@
+# @datocms/svelte
+![MIT](https://img.shields.io/npm/l/@datocms/svelte?style=for-the-badge) ![NPM](https://img.shields.io/npm/v/@datocms/svelte?style=for-the-badge) [![Build Status](https://img.shields.io/github/actions/workflow/status/datocms/datocms-svelte/node.js.yml?branch=main&style=for-the-badge)](https://github.com/datocms/datocms-svelte/actions/workflows/node.js.yml)
+A set of components to work faster with [DatoCMS](https://www.datocms.com/) in Svelte projects.
+- Works with Svelte and SvelteKit;
+- Written in TypeScript;
+- Usable both client and server side;
+<br /><br />
+<a href="https://www.datocms.com/">
+<img src="https://www.datocms.com/images/full_logo.svg" height="60">
+</a>
+<br /><br />
+## Table of Contents
+- [Features](#features)
+- [Installation](#installation)
+- [Development](#development)
+## Features
+`@datocms/svelte` contains ready-to-use Svelte components and usage examples.
+Components:
+- [`<Image />`](src/lib/components/Image)
+- [`<StructuredText />`](src/lib/components/StructuredText)
+- [`<Head />`](src/lib/components/Head)
+## Installation
+```
+npm install @datocms/svelte
+```
+## Development
+This repository contains some examples in the `app/routes` folder. You can use them to locally test your changes to the package:
+```bash
+npm run dev
+```
+## Building
+To create a production version of this library:
+```bash
+npm run build
+```

package/components/Head/Head.svelte ADDED Viewed

@@ -0,0 +1,14 @@
+<script context="module"></script>
+<script>export let data = [];
+</script>
+<svelte:head>
+	{#each data as { tag, attributes, content }}
+		{#if content}
+			<svelte:element this={tag} {...attributes}>{content}</svelte:element>
+		{:else}
+			<svelte:element this={tag} {...attributes} />
+		{/if}
+	{/each}
+</svelte:head>

package/components/Head/Head.svelte.d.ts ADDED Viewed

@@ -0,0 +1,61 @@
+import { SvelteComponentTyped } from "svelte";
+export interface TitleMetaLinkTag {
+    /** the tag for the meta information */
+    tag: string;
+    /** the inner content of the meta tag */
+    content?: string | null | undefined;
+    /** the HTML attributes to attach to the meta tag */
+    attributes?: Record<string, string> | null | undefined;
+}
+export interface SeoTitleTag {
+    tag: 'title';
+    content: string | null;
+    attributes?: null;
+}
+export interface RegularMetaAttributes {
+    name: string;
+    content: string;
+}
+export interface OgMetaAttributes {
+    property: string;
+    content: string;
+}
+export interface SeoMetaTag {
+    tag: 'meta';
+    content?: null;
+    attributes: RegularMetaAttributes | OgMetaAttributes;
+}
+export interface FaviconAttributes {
+    sizes: string;
+    type: string;
+    rel: string;
+    href: string;
+}
+export interface AppleTouchIconAttributes {
+    sizes: string;
+    rel: 'apple-touch-icon';
+    href: string;
+}
+export interface SeoLinkTag {
+    tag: 'link';
+    content?: null;
+    attributes: FaviconAttributes | AppleTouchIconAttributes;
+}
+export type SeoTag = SeoTitleTag | SeoMetaTag;
+export type FaviconTag = SeoMetaTag | SeoLinkTag;
+export type SeoOrFaviconTag = SeoTag | FaviconTag;
+declare const __propDef: {
+    props: {
+        data?: (TitleMetaLinkTag | SeoOrFaviconTag)[] | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type HeadProps = typeof __propDef.props;
+export type HeadEvents = typeof __propDef.events;
+export type HeadSlots = typeof __propDef.slots;
+export default class Head extends SvelteComponentTyped<HeadProps, HeadEvents, HeadSlots> {
+}
+export {};

package/components/Head/README.md ADDED Viewed

@@ -0,0 +1,68 @@
+## Social share, SEO and Favicon meta tags
+Just like the image component, `<Head />` is a component specially designed to work seamlessly with DatoCMS’s [`_seoMetaTags` and `faviconMetaTags` GraphQL queries](https://www.datocms.com/docs/content-delivery-api/seo) so that you can handle proper SEO in your pages.
+You can use `<Head />` your components, and it will inject title, meta and link tags in the document's `<head></head>` tag.
+### Table of contents
+- [Usage](#usage)
+- [Example](#example)
+### Usage
+`<Head />`'s `data` prop takes an array of `Tag`s in the exact form they're returned by the following [DatoCMS GraphQL API](https://www.datocms.com/docs/content-delivery-api/seo) queries:
+- `_seoMetaTags` query on any record, or
+- `faviconMetaTags` on the global `_site` object.
+### Example
+Here is an example:
+```svelte
+<script>
+  import { onMount } from 'svelte';
+  import { Head } from '@datocms/svelte';
+  const query = gql`
+    query {
+      page: homepage {
+        title
+        seo: _seoMetaTags {
+          attributes
+          content
+          tag
+        }
+      }
+      site: _site {
+        favicon: faviconMetaTags {
+          attributes
+          content
+          tag
+        }
+      }
+    }
+  `;
+  export let data = null;
+  onMount(async () => {
+    const response = await fetch('https://graphql.datocms.com/', {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: 'Bearer faeb9172e232a75339242faafb9e56de8c8f13b735f7090964'
+      },
+      body: JSON.stringify({ query })
+    });
+    const json = await response.json();
+    data = [...json.data.page.seo, ...json.data.site.favicon];
+  });
+</script>
+<Head {data} />
+```

package/components/Head/__tests__/Head.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ import '@testing-library/jest-dom';

package/components/Head/__tests__/Head.test.js ADDED Viewed

@@ -0,0 +1,11 @@
+import { describe, expect, it } from 'vitest';
+import '@testing-library/jest-dom';
+import { render, } from '@testing-library/svelte';
+import { Head } from '../../..';
+import { metaTags } from './__fixtures__/head';
+describe('Head', () => {
+    it('renders meta tags', () => {
+        const { container } = render(Head, { props: { data: metaTags } });
+        expect(container.ownerDocument.head).toMatchSnapshot();
+    });
+});

package/components/Head/__tests__/__fixtures__/head.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import type { TitleMetaLinkTag } from '../../Head.svelte';
2	+ export declare const metaTags: TitleMetaLinkTag[];

package/components/Head/__tests__/__fixtures__/head.js ADDED Viewed

@@ -0,0 +1,280 @@
+export const metaTags = [
+    {
+        content: 'Remix CMS - The easiest way to manage content with Remix',
+        attributes: null,
+        tag: 'title'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:title',
+            content: 'Remix CMS - The easiest way to manage content with Remix'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            name: 'twitter:title',
+            content: 'Remix CMS - The easiest way to manage content with Remix'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            name: 'description',
+            content: 'Remix makes building scalable and fast React apps simple, pair it with a CMS that shares the same intuitiveness. Start a new Remix + Dato project now.'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:description',
+            content: 'Remix makes building scalable and fast React apps simple, pair it with a CMS that shares the same intuitiveness. Start a new Remix + Dato project now.'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            name: 'twitter:description',
+            content: 'Remix makes building scalable and fast React apps simple, pair it with a CMS that shares the same intuitiveness. Start a new Remix + Dato project now.'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:image',
+            content: 'https://www.datocms-assets.com/205/1642515293-full-logo.svg?fit=max&fm=jpg&w=1000'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:image:width',
+            content: '746'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:image:height',
+            content: '186'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            name: 'twitter:image',
+            content: 'https://www.datocms-assets.com/205/1642515293-full-logo.svg?fit=max&fm=jpg&w=1000'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:locale',
+            content: 'en'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:type',
+            content: 'article'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'og:site_name',
+            content: 'DatoCMS'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            property: 'article:modified_time',
+            content: '2022-01-18T14:02:47Z'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            name: 'twitter:card',
+            content: 'summary_large_image'
+        },
+        tag: 'meta'
+    },
+    {
+        content: null,
+        attributes: {
+            name: 'twitter:site',
+            content: '@datocms'
+        },
+        tag: 'meta'
+    },
+    {
+        attributes: {
+            sizes: '16x16',
+            type: 'image/png',
+            rel: 'icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=16&w=16'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '32x32',
+            type: 'image/png',
+            rel: 'icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=32&w=32'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '96x96',
+            type: 'image/png',
+            rel: 'icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=96&w=96'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '192x192',
+            type: 'image/png',
+            rel: 'icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=192&w=192'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '57x57',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=57&w=57'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '60x60',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=60&w=60'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '72x72',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=72&w=72'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '76x76',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=76&w=76'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '114x114',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=114&w=114'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '120x120',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=120&w=120'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '144x144',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=144&w=144'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '152x152',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=152&w=152'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            sizes: '180x180',
+            rel: 'apple-touch-icon',
+            href: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=180&w=180'
+        },
+        content: null,
+        tag: 'link'
+    },
+    {
+        attributes: {
+            name: 'msapplication-square70x70logo',
+            content: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=70&w=70'
+        },
+        content: null,
+        tag: 'meta'
+    },
+    {
+        attributes: {
+            name: 'msapplication-square150x150logo',
+            content: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=150&w=150'
+        },
+        content: null,
+        tag: 'meta'
+    },
+    {
+        attributes: {
+            name: 'msapplication-square310x310logo',
+            content: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=310&w=310'
+        },
+        content: null,
+        tag: 'meta'
+    },
+    {
+        attributes: {
+            name: 'msapplication-square310x150logo',
+            content: 'https://www.datocms-assets.com/205/1525789775-dato.png?h=150&w=310'
+        },
+        content: null,
+        tag: 'meta'
+    }
+];