palmetto components

Palmetto -Komponentenbibliothek

Eine React -Komponentenbibliothek, um die gesamte Palmetto -Benutzeroberfläche mit Strom zu versorgen

Schneller Start

1. Installieren

yarn add @palmetto/palmetto-components

2. Global CSS importieren

@ import '@palmetto/palmetto-components/dist/css/utilities.css' ; // Utility classes -- REQUIRED
@ import '@palmetto/palmetto-components/dist/css/variables.css' ; // CSS Variables -- REQUIRED
@ import '@palmetto/palmetto-components/dist/css/index.css' ; // Component CSS -- REQUIRED
@ import '@palmetto/palmetto-components/dist/css/fonts.css' ; // Included Font files -- OPTIONAL BUT ENCOURAGED

Wir empfehlen den Importieren unseres globalen Resets, um ein konsistentes Aussehen aller Komponenten über Anwendungen hinweg aufrechtzuerhalten.

@ import '@palmetto/palmetto-components/dist/css/reset.css' // A Basic CSS Reset -- OPTIONAL BUT ENCOURAGED.

3. Nutzung

 import React from 'react' ;
import ReactDOM from 'react-dom' ;
import { Button } from '@palmetto/palmetto-components' ;

function App ( ) {
  return < Button > Hello World </ Button > ;
}

ReactDOM . render ( < App /> , document . querySelector ( '#app' ) ) ; 

Dokumentation

Siehe vollständige Dokumente hier

Beitragen

Probleme und PRs willkommen! Hier finden Sie unseren Beitragsführer.

Ein Problem aufwerfen

Bei der Anregung eines Problems:

• Stellen Sie sicher, dass das Problem noch nicht angesprochen wurde.
• Tag -Ausgabe entsprechend Ihr bestes Urteilsvermögen. Erstellen Sie keine neuen Tags. Wenn Sie der Meinung sind, dass ein neues benötigt wird, erhöhen Sie es in Ihrem Problem.
• Wenn es sich bei Ihrem Problem um einen Fehler handelt, geben Sie Screenshots oder animierte GIFs in Ihr Problem bei, wann immer erforderlich (wenn das Problem visuell ist).
• Wenn es sich bei Ihrem Problem um einen Fehler handelt, geben Sie Schritte zur Reproduktion oder Verknüpfung mit reproduzierbarem Problem bei, z. B. Code -Sandbox oder ähnlich. Bitte geben Sie außerdem zusätzliche Details an, einschließlich Gerät, Betriebssystem, Browser, Browserversion usw.

Hier können Probleme aufgeworfen werden.

Lizenz

Dieses Projekt ist gemäß den Bedingungen der MIT -Lizenz lizenziert.