0.1.7 • Published 1 year ago

@thanhdungttrd172/eshop-theme v0.1.7

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

React Component Library Template

Thực hiện: DEV

Cập nhật lần cuối: 23/04/2022

Mục lục

I. Các bước tạo mới component( Dự án Eshop)

1. Tạo component?

2. Import component

3. Update version component

II. NPM Link

1. Tìm Hiểu NPM Link

2. Sử dụng NPM Link

III. Cách sử dụng thư viện

1. Cách sử dụng

2. Fix lỗi thường gặp

IV. Component & API

1. Button

2. InputSearch

3. CustomDatePicker

4. CustomDateTimePicker

5. CustomSelect

I. Các bước tạo mới component ( Dự án Eshop)

1.Tạo componnet

  • Clone code từ ..
  • Tạo folder tên component trong thư mục components với cấu trúc:
  • index.ts
  • name.txs
  • name.scss

VÍ DỤ

2.Import component

  • Import component vào file index.js
  • npm run roolup : build các componet thành file .js

3.Update version component :

  • Thay đổi version ở file pakage.json VÍ DỤ
  • npm publish

II. NPM Link

1.Tìm Hiểu NPM Link

    • Tác dụng:
  • Tạo sự phụ thuộc để liên kết: Tạo ra 1 liên kết tượng trưng trong node_modules, thư mục để bất kỳ sửa đổi bạn thực hiện trong một mô-đun sẽ ngay lập tức được phản ánh trong bất kỳ dự án đã được thành lập để phụ thuộc vào đó (địa phương) phiên bản của mô-đun.

2.Sử dụng NPM Link

    • Cách sử dụng: Tạo một shortcut trên dependency với npm link. Shortcut này trỏ tới vị trí thư mục khác trên local.
  • npm link ( trong node_mudules cần tạo liên kết) => tạo một liên kết tượng trưng trong thư mục chung
  • npm link name (name: tên tương ứng trong node-modules)
  • //lưu ý: nên sửa tên node_modules khác với tên thư viện đã import từ github

VÍ DỤ

  • Import thư viện: import { ... } from "name"

III. Cách sử dụng thư viện "findxdn/erp/theme"

1.Cách sử dụng

  • Tạo file .npmrc trong project với data registry=https://registry.npmjs.org/ @findxdn:registry=https://npm.pkg.github.com/ //npm.pkg.github.com/:_authToken=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
  • npm i @findxdmn/erp-theme
  • Sử dụng: import { nameComponent } from “findxdn@erp-theme” *- Update phiên bản:
  • Thay đổi tên phiên bản tương ứng trong file pakage.json
  • o npm i

2.Fix lỗi thường gặp

  • Nếu có lỗi như hình, thêm --legacy-peer-deps vào sau mỗi lệnh
  • Ex: npm i --legacy-peer-deps

image

IV. Component và cách sử dụng"

1.Button

NameTypeDefaultDescription
onClickfuncnullfunction handle onclick
childrenstring""Name button
classNamestring""ClassName button
sxany""Style css button
iconany""Icon button
typeanybuttonType button: sudmid / reset / button

2.InputSearch

NameTypeDefaultDescription
namestring""Name inputSearch
inputCustomanynullCustom css input

3.CustomDatePicker

NameTypeDefaultDescription
namestring""Name CustomDatePicker
registeranynull
classNamestring""ClassName CustomDatePicker
onChangeanynullHandle onchange data
errorsanynull
styledanynullCustom css Customdatepiker

4.CustomDateTimePicker

NameTypeDefaultDescription
namestring""Name CustomDateTimePicker
valueanynullValue default datetimepiker
registeranynull
classNamestring""ClassName CustomDateTimePicker
onChangeanynullHandle onchange data
errorsanynull
styledanynullCustom css Customdatepiker

5.CustomSelect

NameTypeDefaultDescription
isMultiboolfalseMulti select options
groupboolfalseGroup options
onChangefunc()=> {}Change data select
valuelist,int,stringnullData select
maxToShowPropsnumber1Show data select (isMulti)
menuPlacementtop, bottom, autoautoPosition menu options (config _props)
menuPortalnullConfig styles menu

5.1.Example Group:

1.options = [
    {
        label: 'label1',
        key:'key1',
        options: [
            {
                label: 'label1.1',
                key:'key1.1',
                value: 'value1.1'
            },
            {
                label: 'label1.2',
                key:'key1.2',
                value: 'value1.2'
            }
        ]
    },
    {
        label: 'label2',
        key:'key2',
        options: [
            {
                label: 'label2.1',
                key:'key1',
                value: 'value2.1'
            },
            {
                label: 'label2.2',
                key:'key2.2',
                value: 'value2.2'
            }
        ]
    }
]

2.onChange : (inputValue, actions) => { 
    <!-- inputValue : value options-->
    <!-- actions : Action Meta onchange-->
}

3.value: value2.1

5.2.Example IsMulti:

1.options = [
    {
        label: 'label1.1',
        key:'key1.1',
        value: 'value1.1'
    },
    {
        label: 'label1.2',
        key:'key1.2',
        value: 'value1.2'
    }
]

2.onChange : (inputValue, actions) => { 
    <!-- inputValue : list value [value1.1, value1.2]-->
    <!-- actions : Action Meta onchange-->
}

3.value: list value [value1.1, value1.2]

5.3.Example Group and IsMulti:

1.options = [
    {
        label: 'label1',
        key:'key1',
        options: [
            {
                label: 'label1.1',
                key:'key1.1',
                value: 'value1.1'
            },
            {
                label: 'label1.2',
                key:'key1.2',
                value: 'value1.2'
            }
        ]
    },
    {
        label: 'label2',
        key:'key2',
        options: [
            {
                label: 'label2.1',
                key:'key2.1',
                value: 'value2.1'
            },
            {
                label: 'label2.2',
                key:'key2.2',
                value: 'value2.2'
            }
        ]
    }
]

2.onChange : (inputValue, actions) => { 
    <!-- inputValue :list value options [value1.1, value2.1]-->
    <!-- actions : Action Meta onchange-->
}

3.value: list value [value1.1, value2.1]

5.4.Example menuPortal:

const objectPortal = {
    zIndex: 9999
}
<CustomSelect 
    {...props}
    menuPortalTarget={document.body}
    styles={{
        menuPortal: (base) => ({ ...base, ...objectPortal }),
    }} 
/>