README

React Colorflow Libs

npm node types downloads license

The project of Colorflow wrapped-library for React.js

This project has been created by Vessel CLI. For a simple and quick reference about it, click here.

About

Colorflow를 React.js 컴포넌트 형태로 제공되는 패키지.

Installation

해당 라이브러리를 사용 할 프로젝트에서는 아래와 같이 의존성 모듈로 설치한다.

$ npm install --save @mornya/react-colorflow-libs
or
$ yarn add @mornya/react-colorflow-libs

Modules in the package

본 패키지에는 아래와 같은 모듈들을 포함한다.
제공되는 모듈과 메소드 사용법 등은 코드 스니핏을 참고한다.

Colorflow module

CSS Animation을 활용한 Colorflow 구현

Usage

Colorflow 모듈 및 SCSS 파일을 import하여 아래 예제처럼 활용한다.

import React from 'react';
import { Colorflow } from '@mornya/react-colorflow-libs';
import '@mornya/react-colorflow-libs/dist/colorflow.scss';

type Props = {};

const textArray = [
  'This is a sample text',
  'Texts in array',
];
const text = 'simple text';

const Sample: React.FC<Props> = (_props: Props) => {
  return (
    <>
      <Colorflow text={textArray}/>
      <hr/>
      <Colorflow text={text}/>
    </>
  );
};

Change Log

프로젝트 변경사항은 CHANGELOG.md 파일 참조.

License

프로젝트 라이센스는 LICENSE 파일 참조.

Usage no npm install needed!