Dokumentieren Sie Ihre Designsysteme mit Fraktal

Sep 12, 2025
wie man

Lust auf das Lernen mehr über Designsysteme? Verpassen Sie dann nicht den älteren UI-Ingenieur Mina Markham. beim New York generieren Am 28. April, wo sie diskutieren wird, wo sie sich mit Hosenanzug erstellt hat, ist das Designsystem, das viele der Anwendungen auf HillaryClinton.com veranstaltete. Und an der Westküste, an Generieren Sie San Francisco. Am 9. Juni, Stephanie Rewis. Wird einige der Lektionen teilen, die sie beim Bau des Salesforce Design-Systems lernt.

Inzwischen sind viele von uns vertraut mit Stilführungen . Es gibt jedoch eine neue Rasse der Designsystemdokumentation, die Dampf ergibt: die Musterbibliothek. Der Hauptunterschied zwischen den beiden ist die Hauptquelle der Dokumentation des Tools.

Die Dokumentation eines Stilhandbuchs neigt dazu, aus einer Markdown-Datei zu sterben, um die Markierung zu zeigen, um den Autor oft zum Kopieren und Einfügen in das Kennfeld zu zeigen. Dies ist nahezu unmöglich, bei der Montage mehrerer Komponenten zusammen zu halten.

Eine Musterbibliothek dagegen behandelt unsere Komponente HTML-Dateien als erstklassige Bürger. Jede Komponente erhält seine eigene Seite, wo er das Markup anzeigt und HTML direkt aus der HTML-Datei ausgerichtet ist. Dadurch wird sichergestellt, dass die HTML-Dateien und die Dokumentation nie aus der Synchronisierung geraten.

Musterbibliotheken werden häufig mit einer Templating-Sprache anstelle von Plain HTML erstellt. Templates können Variablen und andere Logik enthalten, dann können wir verschiedene Datensätze eingeben, wodurch Variationen einer Komponente angezeigt werden können.

Es ist möglich, mehrere Vorlagen zu kombinieren, um komplexere Anzeigen oder sogar vollständige Seiten zu erstellen. Diese Dateien sind so flexibel, dass sie sogar in der Produktion verwendet werden können! Alle Änderungen an unserer Musterbibliothek werden automatisch von unserer Website aufgenommen, wie alle Markup - für die Bibliothek oder für die Produktion - stammt von einem einzigen Satz kanonischer Vorlagen.

Design systems will be covered at both Generate New York and San Francisco this year

Designsysteme werden in diesem Jahr sowohl in New York als auch in San Francisco generiert

Fraktal eingeben

Erstellt von clearleft, Fraktal Hilft Ihnen, Webkomponentenbibliotheken aufzubauen und zu dokumentieren, und integrieren sie in Ihre Projekte. In diesem Tutorial sehen wir uns näher an, wie es funktioniert (laden Sie eine fertige Version der Demo herunter an Hier ).

Fractal ist ein node.js-Modul, das über NPM installiert ist. Zuerst möchten Sie das Modul global installieren, damit Sie ein neues Projekt generieren können: 

npm install --global @frctl/fractal

Mit diesem Paket installiert, erstellen Sie ein neues Projekt: 

fractal new project-name

Dieser Befehl feuert einen Installationsanleitung aus, der Sie durch den Setup-Prozess läuft. Es wird Sie nach dem Titel des Projekts gebeten. die Namen der Komponenten, Dokumentation und öffentlichen Ordner; Und wenn Sie GIT für die Versionskontrolle verwenden. Sobald diese Fragen abgeschlossen sind, installiert Fractal alle erforderlichen Module und richtet eine Ordnerstruktur, genau wie angegeben.

Wenn Sie die globale Installation überspringen und das Projekt manuell erstellen möchten, können die manuellen Installationsanweisungen bei gefunden werden Hier .

Es aufdrehen

Jetzt haben Sie ein vollständig installiertes Fractal-Projekt, drehen Sie ihn, indem Sie in den Projektordner einsteigen CD-Projektname und Ausführen des Fractal Sync-Befehls. Dadurch wird ein lokaler Server gestartet, achtet die Dateien für Änderungen und startet automatisch BrowserSync: 

fractal start --sync

Und genauso wie das haben Sie einen Arbeitsbereich von Fractal. Öffnen Sie Ihren Browser der Wahl und navigieren Sie zu http: // localhost: 3000 um den Start Ihres neuen Fractal-Projekts zu sehen. Um zu vermeiden, dass jeder, um Fractal global zu installieren, erstellen Sie ein Skript in Ihrem package.json. das ruft das fraktale binäre an. 

 "Skripte": {
    "Fractal": "./node_modules/.bin/fractal start --sync"
}

Jetzt können Sie verwenden NPM Run Fractal ohne alles global installieren zu müssen.

Bauteil hinzufügen

Jetzt haben Sie ein Fractal-Projekt begonnen, es ist Zeit, einige Komponenten hinzuzufügen. Die Starter-Dateien werden mit einer Komponente mit dem Namen "Beispiel" geliefert, aber wir werden das loswerden und einen neuen von Grund auf machen.

Eines der besten Dinge über Fraktal ist, dass Sie Ihre Komponenten jedoch organisieren können, jedoch in den Komponentenordner, und es wird automatisch diese Organisation in der Musterbibliotheksnavigation nachahmen.

Für die erste Komponente erstellen wir einen neuen Primärknopf in einem Schaltflächenordner . Um das zu tun, erstellen Sie mit einer Vorlagendatei bei Komponenten / Schaltflächen / Primärknopf / Primärknopf. . Fractal unterstützt Lenkervorlagen aus der Box, also verwenden Sie das .hbs. Dateierweiterung:

& lt; Button-Klasse = "Primärtaste" & GT; {{Text}} & lt; / button & gt;

Das {{Text}} Zeichenfolge innerhalb des Button-Tags ist ein variabler Platzhalter, und dadurch können Sie die Vorlage wiederverwenden, indem Sie verschiedene Werte angeben Text aus der Datendatei.

Verwenden Sie zum Erstellen der Datendatei denselben Basisnamen wie die Lenkerdatei, jedoch mit einem anderen yml. Erweiterung. Jetzt die primär-button.config.yml. im Inneren sitzen Komponenten / Schaltflächen / Primärtasten Der Ordner sollte so aussehen: 

 Titel: Primärknopf
Kontext:
    Text: Klicken Sie auf mich

All dies zusammen erstellt Ihre erste neue Komponente, den primären Knopf, ein Mitglied der Schaltflächenkategorie, mit dem Text: 'Klicken Sie auf mich'.

Komponentenvariationen

Fraktal unterstützt Variationen derselben Komponente, sodass wir dieselbe Komponente mit verschiedenen Modifikationsklassen oder Attributen anzeigen können. Nehmen wir an, wir wollten die Möglichkeit haben, einen dunklen thematischen Taster zu verwenden. Wir könnten eine neue Vorlagendatei erstellen Primärknopf - dark.hbs Neben unserer ursprünglichen Vorlage (der doppelte Dash bedeutet diese Komponentenvariationen). In dieser Vorlage wenden wir einen Modifikator an, in den wir eintreffen können, um neue Stile anzubringen. 

 & lt; Button-Klasse = "Primärtaste" Data-Theme = "dark" & gt; {{Text}} & lt; / button & gt;

Wenn wir jetzt unsere CSS schreiben, können wir den folgenden Wähler aufnehmen, um diese Vorlage mit modifizierenden Stilen zu ändern. 

 .Prise-Taste [Data-Theme = "dunkel"] {}

Datenvariationen

So wie wir Variationen definieren können, indem wir mehrere Vorlagendateien erstellen, können wir auch Variationen in unseren Daten erstellen. Wir können das in der primär-button.config.yml. Datei, indem Sie ein Varianten-Array hinzufügen. 

 Titel: Primärknopf
Kontext:
    Text: Klicken Sie auf mich
Varianten:
- Name: Download
    Kontext:
Text: Jetzt herunterladen
- Name: Installieren
    Kontext:
Text: Jetzt installieren

Dadurch erstellt neue Variationen mit dem Namen 'Download' und 'install', wobei ein anderer Text in die Schaltfläche geleitet wird. Ein praktischeres Beispiel könnte sein, wenn Sie das gleiche verwenden primärknopf.hbs. Vorlage in Fraktal sowie Produktion. In diesem Fall, anstatt eine brandneue Vorlage für Ihr dunkles Thema zu erstellen, können Sie den Themenwert als Variable angeben und die Datenvariationen verwenden, um alle verschiedenen Schaltflächen-Themen anzuzeigen. 

 & lt; Button-Klasse = "Primärtaste" Data-Theme = "{{Theme}}" {{{{{Text}}} & lt; / button & gt;

Titel: Primärknopf
Kontext:
    Text: Klicken Sie auf mich
    Thema: Licht
Varianten:
- Name: Dark Theme
    Kontext:
Text: Klicken Sie auf mich
Thema: dunkel

Verhalten anderer Vermögenswerte.

Fractal behandelt auch andere Dateien als Markup und Daten. Alle CSS, JavaScript, Bilder oder andere Vermögenswerte, die Sie zum Komponentenordner hinzufügen, werden in der Registerkarte "Assets" angezeigt. Sie können eine angeben Readme.md. Datei für die Komponente, sodass Sie Notizen zum Beispiel schreiben können, wie die Komponente verwendet wird, oder verknüpfen Sie mit anderen Teilen der Dokumentation.

Nächste Schritte

Das Wiederholen des vorherigen Beispiels für alle Ihre Kernkomponenten erstellt einen nützlichen Katalog der Hauptbausteine ​​Ihrer Website. Die echte Kraft einer Musterbibliothek stammt jedoch von der Fähigkeit, diese Teile zusammen zu kombinieren. Beachten Sie unbedingt das Fraktale Dokumentation. Um zu erfahren, wie Sie mit dem Erstellen komplexerer Komponenten, indem Sie kleinere atomare Elemente erstellen können, um größere zu erstellen.

Der Docs-Ordner ist ein großartiger Ort, um traditionelle Informationen zum traditionellen Stil und ergänzende Notizen zu setzen. Dies kann Dinge wie die Dokumentation, Richtlinien, Richtlinien für die Sprache und den Ton Ihrer Marke, der Farben und -listen von Farben und Variablen abdecken. Es folgt die gleiche Ordner-basierte Navigation als Komponenten, und wenn Sie Ihre Dateien in den Fachordnern organisieren, finden Sie Navigation der Fractal Docs. ein Hauch.

Fractal unterstützt auch komplexere Datenquellen. Wenn Sie einen großen Datensatz für eine Vorlage generieren müssen, oder möchten Sie es von einem anderen API von Drittanbietern ziehen möchten, können Sie verwenden Komponentenname.config.js. um ein JavaScript-Objekt anstelle der YML-Dateidaten zurückzugeben.

Schließlich ermöglicht Fractal Sie, eine Anzahl verschiedener Vorlagen-Sprachen zu verwenden. Beachten Sie unbedingt die vollständige Liste in seiner Dokumentation. Und vor allem viel Spaß!

Buchen Sie Ihre Tickets an Generieren heute! Im New York Sie können von Mina Markham lernen, der das Designsystem für die Präsidentschaftskampagne von Hillary Clinton errichtet hat, und in San Francisco Stephanie Rewis wird erklären, wie Sie einen modernen CSS-Framework für ein "Living Design-System" in der Unternehmensskala aufbauen können.

Dieser Artikel wurde ursprünglich in der Netto-Magazin-Ausgabe 285 veröffentlicht, Kaufen Sie es hier.

wie man - Die beliebtesten Artikel

Wie man Pin-up-Kunst erstellt

wie man Sep 12, 2025

Die Ursprünge von Pin-up-Kunst können in das späte 19. Jahrhundert zurückverfolgt werden, aber es wurde in den 1940er und 1950er Jahren weiter verbreitet, der häufig auf Poster und Kalen..

Erstellen Sie eine sprachgesteuerte Benutzeroberfläche

wie man Sep 12, 2025

Wir haben gesehen, dass viele neue APIs in den letzten Jahren in das Web hinzugefügt wurden, die den Webinhalt wirklich aktiviert haben, um dieselbe Art von Funktionalität zu haben, da viel..

10 Möglichkeiten, bessere 3D-Weltumgebungen aufzubauen

wie man Sep 12, 2025

[Bild: Albert Valls PunSich] Wenn Sie als 3D-Künstler auf Ihrem Spiel bleiben möchten, ist es wichtig, dass Sie ab ..

Affinity Designer: Wie man Einschränkungen verwendet

wie man Sep 12, 2025

Affinity Designer ist ein beliebter Vektorkunst Werkzeug. Sowie Mac- und Windows-Versionen, SerIF kürz..

Beginnen Sie mit dem MONOTYPE-Druck

wie man Sep 12, 2025

Manchmal brauchen Sie die Dinge mit Ihrem Bleistiftzeichnungen. und lassen Sie den Impuls los, um zu viel zu tun. ..

Jump Start Reagieren Sie nativ mit der Expo

wie man Sep 12, 2025

Nativ reagieren ist eine Plattform, mit der Sie native mobile Apps mit JavaScript erstellen können. Wie der Name imp..

Malen Sie eine epische New Yorker Szene

wie man Sep 12, 2025

Für diesen Workshop malerei ich eines meiner Lieblingsfächer: eine New York City Bridge. Ich habe die Brooklyn Bridge schon oft in einem anderen Licht gemalt, also habe ich für dieses Proj..

Perspektive erstellen, indem Sie Ihre Texturen in Photoshop verziehen

wie man Sep 12, 2025

Ich bin ein fester Gläubiger, dass Sie sich nicht nur auf Software verlassen sollten, um die Arbeit für Sie zu erledigen. Ein g..

Kategorien