palmetto components

Bibliothèque de composants Palmetto

Une bibliothèque de composants React pour alimenter toute l'interface utilisateur du palmier

Démarrage rapide

1. Installer

yarn add @palmetto/palmetto-components

2. Importer Global CSS

@ 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

Nous vous recommandons d'importer notre réinitialisation mondiale afin de maintenir un aspect cohérent de toutes les composants entre les applications.

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

3. Utilisation

 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' ) ) ; 

Documentation

Voir les documents complets ici

Contributif

Les problèmes et les PR sont les bienvenus! Voir ici pour notre guide de contribution.

Soulever un problème

Lorsque vous soulevez un problème:

• Assurez-vous que le problème n'a pas encore été soulevé.
• Le problème de balise en conséquence en utilisant votre meilleur jugement. Ne créez pas de nouvelles balises. Si vous en sentez un nouveau est nécessaire, soulevez-le dans votre numéro.
• Si votre problème est un bogue, incluez des captures d'écran ou des GIF animés dans votre numéro chaque fois que cela est nécessaire (si le problème est de nature visuelle).
• Si votre problème est un bogue, incluez des étapes à reproduire, ou lien vers un problème reproductible, par exemple: code sandbox ou similaire. Veuillez également fournir des détails supplémentaires, notamment l'appareil, le système d'exploitation, le navigateur, la version du navigateur, etc.

Des problèmes peuvent être soulevés ici.

Licence

Ce projet est concédé sous licence de la licence du MIT.