svelte-component-templates

DER SPIEGEL templates for Svelte components

Utility components

Datawrapper.svelte

Einbau einer Datawrapper-WebComponent inklusive Zugriff auf dessen Methoden.

Properties

export let id;
export let viz;

Usage

<Datawrapper id={DATAWRAPPER_ID} bind:viz />

function updateViz(key, value) {
    if (!viz) return;
    viz.patch(key, value);
}

TextAlign.svelte

Align child elements to the type area of spiegel.de.

Properties

// type of the app: iframe or embed
export let type = 'iframe';

// disable component (if true, no alignment takes place)
export let disable = false;

ViewHeight.svelte

Determine the size of device screen height using vh.

Properties

    export let visualHeight;
    export let headerHeight;
    export let footerHeight;
    export let contentHeight;
    export let safeHeight;
    export let threshold = 180;

Usage

<ViewHeight bind:visualHeight bind:contentHeight bind:footerHeight />

SizeDetector.svelte

Determine the size of an element without using Svelte iFrames and bind:clientWidth etc.

Good for apps that will be embedded directly.

Properties

// width and height can be bound from outside
export let width = undefined;
export let height = undefined;

Usage

<SizeDetector
    bind:width={width}
    bind:height={height}
>
    <div>stuff to be measured</div>
</SizeDetector>

Animation and transition components

NumberSwitcher.svelte

Animate the transition between two numbers (or characters).

Example: Silvester countdown.

Properties

// the number (character) itself
export let number;
// y-offset for the transition (in px)
export let offset = 50;
// transition duration (in ms)
export let duration = 600;
// delay (in ms)
export let delay = 0;
// number(character) width (in px), needed for non-shifting layout
export let width = 32;
// deactivate transition
export let deactivate = false;

Simple HTML components

Button.svelte

A simple "DER SPIEGEL"-Button with event dispatcher

Example: 75 Jahre DER SPIEGEL

Properties

// the text shown on the Button
export let text;
// dispatch the click event
on: buttonClicked;

CardLayout.svelte

Erzeugt einen Schatten um einen Inhalt, sodass dieser wie auf einer Karte präsentiert wird

Example: Wahlergebnis der Präsidentschartswahl in Frankreich 2022

Properties: Keine

Unnamed Slot

<CardLayout>
    <!-- Markup -->
</CardLayout>

Hinweis: Durch den Schatten gibt es ein Margin, das im SCSS der Komponente definiert ist und den Card-Content einrückt. Diese Margin-Variable sollte in allgemeine Konfiguration gezogen werden, um Inhalte ohne Card-Layout (z.B. Headlines) auf gleicher Höhe auszurichten.

$horizontalSpacingCards: 0.2rem !default;

Header.svelte

Header-Komponente mit Titel und Unterzeile, Titel-Schriftgröße von Fensterbreite abhängig

Properties

// Beide Werte optinal; Typ: String
export let title;
export let subtitle;

Sources.svelte

Quellen-Komponente mit vorangestelltem SPIEGEL-"S •"

Properties

// Typ: String; bei Leer-String oder Leerzeichen keine Ausgabe
export let sources;

Link.svelte

Simpler Artikel-Link (ohne Spiegel-Signet).

Properties

export let href;

LoadingAnimation.svelte

Ladeanimation (rotierender Halbkreis um SPIEGEL-S) mit Mindesthöhe von 140 Pixeln

Properties

export let height = 333;

PaddedMultiline.svelte

Text-Block-Element (span, display: inline-block), bei dem nur der Text und nicht das ganze Element mit Hintergrundfarbe und Padding versehen wird. Das Padding wird bei Zeilenumbruch in jeder Zeile gezeigt, nicht nur zu Beginn und am Ende des Textes.

Unnamed Slot

<script>
  import PaddedMultiline from "$compontents/PaddedMultiline.svelte";
</script>

<PaddedMultiline>
  <!-- Text bzw {@html text} -->
</PaddedMultiline>

Properties

// Wert optinal; Typ: Object
export let options = {};

Default-Options

{
    background: "rgba(0, 0, 0, 0.9)",
    color: "rgba(255, 255, 255, 0.9)",
    padding: "0.2rem 0.5rem"
    borderRadius: 1.5px
}

Default-Options werden mit Options gemerged.

Das Options-Objekt kann die Werte wie in Default-Options enthalten. Für background und color gibt es die Varianten mit Suffix für Dark- und Light-Mode: background_dm, color_dm, background_lm, color_lm.

Gibt es diese Varianten nicht, werden die Werte background und color für den Light-Mode verwendet, und im Dark-Mode vertauscht genutzt: color definiert den Hintergrund, background die Schriftfarbe.

AutoCompleteSelect.svelte

Hinweis: Diese Komponente ist in der Kategorie "Simple HTML components" nur eingeschränkt richtig platziert.

Dieses Select-Element bietet nicht nur eine Auswahl-/Ausklapp-Liste, sondern auch ein "Autocomplete": beim Tippen in das Suchfeld werden die Listen-Einträge nach dem Suchwort gefiltert.

Diese Komponente ist ein Wrapper für das Package svelte-select, das ab Version 5 vorausgesetzt wird. Bei Benutzung der Komponenten-Datei ist also npm i svelte-select auszuführen.

Das Package "svelte-select" wurde im August 2024 in der Version 5.8.3 verwendet (leben/2024/studentisches_wohnen).
Mit Vite 5 und der Import-Anweisung import Select from 'svelte-select' gibt es eine unschöne Fehlermeldung:
❌ Error: ... No known conditions for "." specifier in "svelte-select" package
✅️ Lösung: Die Import-Anweisung erweitern:
import Select from "svelte-select/Select.svelte"

Properties

// A) Datenfluss in die Komponente
export let showSelectLabel = true;
export let selectLabel = "";
export let data = [];
export let selectOptions = {};

// B) Datenfluss aus der Komponente heraus
// aktuell ausgewähltes Listen-Element
export let selectedItem;
// Cursor im Input-Element oder nicht; intern gesetzt
export const selectFocused = writable(false);
// Methode: löscht Inhalt aus Input
export const clearInput

Usage

<script>
  import AutoCompleteSelect from "$compontents/AutoCompleteSelect.svelte";
</script>

<AutoCompleteSelect
    selectLabel="Select mit Einträge-Liste komplexer Daten"
    selectOptions="{{
        dataFieldNames: {key: 'iso', label: 'country'},
        additionalSearchFields: ['iso', 'alt']
    }}"
    data="{[{iso: 'alb', country: 'Albanien'}, {iso: 'gbr', country: 'Vereinigtes Königreich', alt: 'uk'}]}"
    bind:clearInput
    bind:selectedItem
></AutoCompleteSelect>
{#if selectedItem}
    <p on:click={() => clearInput()}>Ausgewählt: {selectedItem.label}</p>
{/if}

Über dem Select-Element kann ein Label stehen, Text und Sichtbarkeit werden getrennt gesteuert.

Das Data-Array kann entweder einfache Daten enthalten (String / Number) oder Objekte. Darin muss ein Feld ID/Key-artig sein, ein weiteres als Label in der Liste dienen. Einfache Daten werden intern in Objekte umgewandelt: ["myString", 11] => [{id: "myString", label: "myString"}, {id: "11", label: "11"}] und als solche mit selectedItem zurückgegeben. Bei Objekten im Data-Array ist das vollständige Objekt (nicht nur ID, Label, weitere Suchfelder) in selectedItem.item zu finden.

In den selectOptions: {} können die Namen des ID- bzw. des Label-Datenfeldes festgelegt werden; die Daten müssen nicht id oder label enthalten:

{
  dataFieldNames: {key: "iso3", label: "country"}
}

Weitere Felder des Data-Item-Objekts können als zusätzliche Suchfelder (für das Autocomplete) festgelegt werden.

{
    additionalSearchFields: ['iso3', 'continent'];
}

Mit swe könnte im Beispiel der Eintrag mit dem Label Schweden gefunden werden, mit afrika alle Länder, die diesem Kontinent im Datenfeld continent zugewiesen sind.

Der Default-Placeholder Suche des Input-Feldes kann in den selectOptions überschrieben werden:

{
    placeholder: 'Flughafen-Suche';
}

Weitere Optionen sind im Code der Komponente in const defaultSelectOptions nachzulesen.

Dropdown.svelte

Die Komponente erwartet eine solche config:

config = {
    startOption: 0,
    selectOnInit: 0,
    items: [
        { label: 'Ah', value: '2' },
        { label: 'Be', complex: { a: -1, b: 12 } },
    ],
};

und kann z.B. so eingebaut werden:

<script>
    const config = {
        startOption: 0,
        selectOnInit: 0,
        items: [
            {label: "Ah", value: "2"},
            {label: "Be", complex: {a: -1, b: 12}}
        ]
    };

    const changeHandler = ev => {
        console.log( ev.detail );
    };
</script>

<DropDown {config} on:dropdownChanged={changeHandler}/>

Hallo.