1.13.0-club.2 • Published 8 months ago

@plurix/ecom-components v1.13.0-club.2

Weekly downloads
-
License
-
Repository
github
Last release
8 months ago

@plurix/ecom-components

Dependencies

Use yarn to install all dependencies and prepare husky (used to run scripts in git steps).

Folder Structure

  • lib: files that will be compiled and published in the @plurix/ecom-components package
  • src: local development

How to Create a New Component in the Package

  • Create a new folder in lib/packages, with your component name. Example: MyComponent;
  • Create a .tsx file inside this new folder and export a component from there. Example:
// lib/packages/MyComponent/MyComponent.tsx

export const MyComponent = () => {
  return <h1>My Component</h1>
}
  • Export the new component in lib/main.ts. Example:
// lib/main.ts

export { MyComponent } from './packages/MyComponent/MyComponent'
  • Create a new file called <component-name>Example.tsx in src/examples and import your component. Example:
// src/examples/MyComponentExample.tsx

import { MyComponent } from '../../lib/main'

export const MyComponentExample = () => {
  return (
    <div className="my-component-example-container">
      <MyComponent />
    </div>
  )
}
  • Export the new example component in src/index.ts. Example:
// src/examples/index.ts

export { MyComponentExample } from './MyComponentExample'
  • Run yarn dev;
  • Open the localhost link in the terminal;
  • Choose your component in the sidebar. Now, you can develop your component and test it with fast refresh.

OBS: If you need to use css in your components, create them as <component-name>.global.css and import them in your Lib Component. Then, you are able to use that in VTEX IO and VTEX Faststore.

Imgur

Publishing

  • After finishing your component changes, upgrade the package version in package.json and create an entry in CHANGELOG.md.
  • Commit and push your changes to the remote repository. It will run the husky scripts: commitlint, prettier, lint, tests, and build.
  • After all scripts pass successfully, run npm publish in your terminal.
  • Copy the published version from your terminal and install it in another repository.
  • You can import the new component by using:
import { MyComponent } from '@plurix/ecom-components'
import '@plurix/ecom-components/dist/styles/my-component.global.css' // If you are using css
1.10.7

9 months ago

1.11.0-club.0

8 months ago

1.5.0-club.0

1 year ago

1.11.4

9 months ago

1.11.3

9 months ago

1.11.2

9 months ago

1.11.1

9 months ago

1.11.6

9 months ago

1.11.5

9 months ago

1.6.0-shlo242.0

1 year ago

1.6.0-shlo242.1

1 year ago

1.6.0-shlo242.2

12 months ago

1.10.1

10 months ago

1.10.0

10 months ago

1.12.0

8 months ago

1.10.0-sl2569.25

10 months ago

1.10.0-sl2569.24

10 months ago

1.10.0-sl2569.23

10 months ago

1.10.0-sl2569.22

10 months ago

1.10.0-sl2569.27

10 months ago

1.10.0-sl2569.26

10 months ago

1.10.0-sl2569.21

10 months ago

1.10.0-sl2569.20

10 months ago

1.10.0-sl2569.14

10 months ago

1.10.0-sl2569.13

10 months ago

1.10.0-sl2569.12

10 months ago

1.10.0-sl2569.11

10 months ago

1.10.0-sl2569.18

10 months ago

1.10.0-sl2569.17

10 months ago

1.10.0-sl2569.16

10 months ago

1.10.0-sl2569.15

10 months ago

1.10.0-sl2569.19

10 months ago

1.11.0

9 months ago

1.2.0-sl2399.0

1 year ago

1.9.1

11 months ago

1.9.0

11 months ago

1.10.0-sl2569.10

10 months ago

1.10.0-sl2569.9

10 months ago

1.10.0-sl2569.8

10 months ago

1.10.0-sl2569.7

10 months ago

1.10.0-sl2569.6

10 months ago

1.10.0-sl2569.5

10 months ago

1.10.0-sl2569.4

10 months ago

1.10.0-sl2569.3

10 months ago

1.10.0-sl2569.2

10 months ago

1.10.0-sl2569.1

10 months ago

1.10.0-sl2569.0

10 months ago

1.8.1

12 months ago

1.8.0

12 months ago

1.3.0-loyalty.0

1 year ago

1.7.0-loyalty.0

12 months ago

1.13.0-club.2

8 months ago

1.13.0-club.1

8 months ago

1.13.0-club.0

8 months ago

1.6.0-sl2446.0

1 year ago

1.10.0-sl2680.0

10 months ago

1.10.0-sl2680.1

10 months ago

1.2.0-loyalty.0

1 year ago

1.1.4-loyalty.0

1 year ago

1.1.3-SL-2078.9

1 year ago

1.1.3-SL-2078.8

1 year ago

1.1.3-SL-2078.7

1 year ago

1.1.3-SL-2078.2

1 year ago

1.1.3-SL-2078.1

1 year ago

1.1.3-SL-2078.0

1 year ago

1.1.3-SL-2078.6

1 year ago

1.1.3-SL-2078.5

1 year ago

1.1.3-SL-2078.4

1 year ago

1.1.3-SL-2078.3

1 year ago

1.0.0

2 years ago

1.1.1-sl1964.11

2 years ago

1.1.1-sl1964.10

2 years ago

1.1.3-loyalty.0

1 year ago

1.1.3-loyalty.1

1 year ago

1.1.3-loyalty.2

1 year ago

1.0.0-SL.1698.1

2 years ago

1.0.0-SL.1698.0

2 years ago

1.1.0-loyalty.0

2 years ago

1.1.2-scs1825.1

1 year ago

1.1.2-scs1825.0

1 year ago

1.1.2-scs1825.3

1 year ago

1.1.2-scs1825.2

1 year ago

1.1.2-scs1825.5

1 year ago

1.1.2-scs1825.4

1 year ago

1.1.1-loyalty.1

1 year ago

1.1.1-loyalty.0

2 years ago

1.1.2-scs1825.7

1 year ago

1.1.2-scs1825.6

1 year ago

1.1.2-scs1825.8

1 year ago

1.1.0-SL-1823.0

2 years ago

1.1.0-SL-1823.1

2 years ago

1.1.0-SL-1823.2

2 years ago

1.1.0-SL-1823.3

2 years ago

1.1.0-SL-1823.4

2 years ago

1.1.2-loyalty.0

2 years ago

1.1.2-loyalty.1

2 years ago

1.1.2-loyalty.2

2 years ago

1.1.2-loyalty.3

2 years ago

0.0.2-beta.7

2 years ago

0.0.2-beta.8

2 years ago

0.0.2-beta.9

2 years ago

0.0.2-beta.11

2 years ago

0.0.2-beta.10

2 years ago

0.0.2-beta.4

2 years ago

0.0.2-beta.5

2 years ago

0.0.2-beta.6

2 years ago

0.0.2-beta.2

2 years ago

0.0.2-beta.1

2 years ago

0.0.2-beta.0

2 years ago

0.0.1

2 years ago