gumdrops
1.0.0
Ce projet contient des composants JavaScript réutilisables que vous pouvez importer dans votre projet.
Gumdrops doit être utilisé avec le système de conception de Gumgum (béton), qui gère tous les styles, ainsi que Sass.
Ajoutez Gumgum-Design et Sass à votre projet.
Voir la documentation du système de conception concrète pour les thèmes, les utilitaires CSS et plus encore.
Voir la documentation de cette bibliothèque et de ses composants.
Pour ajouter une version spécifique, vous pouvez utiliser yarn add [email protected] (remplacer 1.0.0 par la version que vous voulez, ou l'omettre pour obtenir la dernière version)
Les versions actuelles et précédentes se trouvent dans ChangeLog.md
La bibliothèque exporte ses composants sous forme de modules ES, vous ne pouvez donc importer que ce dont vous avez besoin, par exemple:
import Button from 'gumdrops/Button';
import Badge from 'gumdrops/Badge';
import Toggle from 'gumdrops/Toggle';
Suivez les documents pour utiliser votre composant avec les accessoires corrects.
Pour la rétrocompatibilité, un bundle CommonJS est fourni. Il contient toute la bibliothèque et peut être utilisé avec:
const gumdrops = require('gumdrops');
// Or
import gumdrops from 'gumdrops';
Pour plus de commodité et d'utilisation directement dans le navigateur, il y a aussi un UMD fourni dans:
node_modules/gumdrops/gumdrops.umd.js
Malheureusement, ESM n'est pas encore largement disponible pour certains outils actuels, et l'exécution de tests à l'aide de composants de cette bibliothèque pourrait lancer des erreurs en raison de la syntaxe du module ES. Pour éviter cela, essayez ce qui suit:
Pour Jest : Jest utilise sa propre implémentation de require et tentera d'analyser les fichiers avec lui et Babel-Jest, il ignore Node_Modules qui entraînera des erreurs de syntaxe à partir des instructions d'importation. Ajoutez la ligne suivante à votre configuration de plaisanterie afin qu'elle ignore tout dans Node_Modules, à l'exception de cette bibliothèque:
"transformIgnorePatterns": ["/node_modules/(?!gumdrops)"]
Pour Mocha + WebPack : il est très probable que vos configurations Mocha et WebPack ignorent également le répertoire Node_Modules, pour éviter toute erreur de syntaxe, chargez Babel via un fichier de configuration au lieu --require babel-register --compilers js:babel-register directement.
Le contenu du fichier peut être aussi simple que:
// testSetup.js
require('babel-register')({
ignore: /node_modules/(?!gumdrops)/
});
// Import it into mocha or mocha-webpack:
--require ./testSetup.js
node: ^16.16.0, npm: ^5.5.1, yarn ^1.2.1.eslinrc et .prettierrc . Il y a un crochet précommande pour exécuter les scripts les plus jolis sur les fichiers. yarn # install dependencies
yarn run storybook
Ensuite, ouvrez http://localhost:6006 sur votre navigateur. Pour plus d'informations, visitez React Storybook Repo.
Veuillez consulter contribution.md pour plus d'informations sur la contribution à ce projet.
Un merci spécial à tous nos contributeurs! Plus les suivants qui ont contribué avant de déménager à Github: David Mejorado, Jose Santos, Mike Watt
Apache 2.0
Remarque importante: Ce projet ne redistribue pas les bibliothèques tierces mais identifie leur disponibilité. Les bibliothèques appelées par ce projet sont soumises à leurs licences de créateur. N'oubliez pas de consulter et de se conformer à toutes les licences dans vos utilisations.
