gumdrops

검 드롭

이 프로젝트에는 프로젝트로 가져올 수있는 재사용 가능한 JavaScript React 구성 요소가 포함되어 있습니다.

전제 조건

Gumdrops는 Sass뿐만 아니라 모든 스타일을 처리하는 Gumgum Design System (콘크리트)과 함께 사용해야합니다.

프로젝트에 Gumgum-Design과 Sass를 추가하십시오.

테마, CSS 유틸리티 등의 콘크리트 설계 시스템 문서를 참조하십시오.

선적 서류 비치

이 라이브러리 및 해당 구성 요소의 문서를 참조하십시오.

설치

특정 버전을 추가하려면 yarn add [email protected] 사용할 수 있습니다 (원하는 버전으로 1.0.0을 교체하거나 최신 버전을 얻으려면 생략하십시오).

현재 및 이전 버전은 ChangeLog.md에서 찾을 수 있습니다.

용법

라이브러리는 구성 요소를 ES 모듈로 내보내므로 필요한 것만 가져올 수 있습니다.

 import Button from 'gumdrops/Button';
import Badge from 'gumdrops/Badge';
import Toggle from 'gumdrops/Toggle';

문서를 따라 올바른 소품으로 구성 요소를 사용하십시오.

후두 양성을 위해, CommonJS 번들이 제공됩니다. 전체 라이브러리가 포함되어 있으며 다음과 함께 사용할 수 있습니다.

 const gumdrops = require('gumdrops');
// Or
import gumdrops from 'gumdrops';

브라우저에서 직접 편의성과 사용을 위해 다음과 같은 UMD도 제공됩니다.

 node_modules/gumdrops/gumdrops.umd.js

문제 해결 테스트

불행히도, ESM은 현재 일부 도구에서 아직 널리 사용할 수 없으며이 라이브러리의 구성 요소를 사용하는 테스트를 실행하면 ES 모듈 구문으로 인해 오류가 발생할 수 있습니다. 이를 방지하려면 다음을 시도하십시오.

• JEST의 경우 : Jest는 자체 요구의 구현을 사용하고 파일과 Babel-Jest와 파일을 구문 분석하려고 시도합니다. 기본적으로 Node_Modules를 무시하여 가져 오기 문의 구문 오류가 발생합니다. 이 라이브러리를 제외하고 Node_Modules의 모든 것을 무시할 수 있도록 JEST 구성에 다음 줄을 추가하십시오.

   "transformIgnorePatterns": ["/node_modules/(?!gumdrops)"]
  

• Mocha + Webpack의 경우 : Mocha 및 Webpack 구성은 Node_Modules 디렉토리를 무시하고 구문 오류를 방지하고 --compilers js:babel-register 또는 --require babel-register 직접로드 할 가능성이 큽니다.

파일 내용은 다음과 같이 간단 할 수 있습니다.

 // testSetup.js
require('babel-register')({
    ignore: /node_modules/(?!gumdrops)/
});

// Import it into mocha or mocha-webpack:
--require ./testSetup.js

현지에서 프로젝트를 운영하기위한 전제 조건

• git 및 git 흐름
• nodejs/npm & yarn : 최소 필수 버전 - 다음 버전으로 테스트했습니다 - node: ^16.16.0, npm: ^5.5.1, yarn ^1.2.1
• Choice 편집자에 Eslint Validators 및 Pretier를 설치하십시오. 프로젝트의 루트에 구성 파일이 있습니다. .eslinrc 및 .prettierrc . 파일에서 더 예쁜 스크립트를 실행하는 사전 커밋 후크가 있습니다.

현지에서 러닝 스토리 북

 yarn # install dependencies
yarn run storybook

그런 다음 브라우저에서 http://localhost:6006 엽니 다. 자세한 내용은 React Storybook Repo를 방문하십시오.

기여

이 프로젝트에 기여한 정보는 Contration.Md를 참조하십시오.

기고자

우리의 모든 기고자들에게 특별한 감사합니다! 우리가 Github로 이사하기 전에 기여한 다음과 같은 다음과 같은 것 : David Mejorado, Jose Santos, Mike Watt

특허

아파치 2.0

중요한 참고 사항 :이 프로젝트는 타사 라이브러리를 재분배하지 않고 이용 가능 여부를 식별합니다. 이 프로젝트에서 불리는 도서관에는 제작자 라이센스가 적용됩니다. 귀하의 용도의 모든 라이센스를 상담하고 준수해야합니다.