@plurix/ecom-components NPM

@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

@acctglobal/skeleton @faststore/ui axios

1.4.0-commerce.SCS-CIT.0

1 year ago

7 months ago

7 months ago

1 year ago

7 months ago

1.5.0-commerce.scs2173.2

11 months ago

1.11.3

7 months ago

1.5.0-commerce.scs2173.3

11 months ago

1.11.2

7 months ago

1.5.0-commerce.scs2173.0

11 months ago

1.11.1

7 months ago

1.5.0-commerce.scs2173.1

11 months ago

1.11.6

7 months ago

1.11.5

7 months ago

1.4.0-commerce.SCS-2154.1

1 year ago

1.4.0-commerce.SCS-2154.0

1 year ago

1.10.0-release240425.3

8 months ago

1.4.0-loyalty.sl2063.1

1 year ago

1.10.0-release240425.4

8 months ago

1.4.0-loyalty.sl2063.0

1 year ago

1.10.0-release240425.1

8 months ago

1.10.0-release240425.2

8 months ago

1.10.0-release240425.0

8 months ago

1.6.0-shlo242.0

11 months ago

1.6.0-shlo242.1

11 months ago

1.10.0-release240425.9

8 months ago

1.6.0-shlo242.2

10 months ago

1.10.0-release240425.7

8 months ago

1.10.1

8 months ago

1.10.0-release240425.8

8 months ago

1.10.0

9 months ago

1.10.0-release240425.5

8 months ago

1.10.0-release240425.6

8 months ago

1.12.0

6 months ago

1.10.0-release240425.29

8 months ago

1.10.0-release240425.26

8 months ago

1.10.0-release240425.25

8 months ago

1.10.0-release240425.27

8 months ago

1.10.0-release240425.22

8 months ago

1.10.0-sl2569.25

8 months ago

1.10.0-release240425.21

8 months ago

1.10.0-sl2569.24

8 months ago

1.10.0-release240425.24

8 months ago

1.10.0-sl2569.23

8 months ago

1.10.0-release240425.23

8 months ago

1.10.0-sl2569.22

8 months ago

1.10.0-sl2569.27

8 months ago

1.10.0-sl2569.26

8 months ago

1.10.0-release240425.37

8 months ago

1.10.0-sl2569.21

8 months ago

1.10.0-release240425.36

8 months ago

1.10.0-sl2569.20

8 months ago

1.10.0-release240425.39

8 months ago

1.10.0-release240425.38

8 months ago

1.10.0-release240425.33

8 months ago

1.10.0-sl2569.14

8 months ago

1.10.0-release240425.32

8 months ago

1.10.0-sl2569.13

8 months ago

1.10.0-release240425.35

8 months ago

1.10.0-sl2569.12

8 months ago

1.10.0-release240425.34

8 months ago

1.10.0-sl2569.11

8 months ago

1.10.0-sl2569.18

8 months ago

1.10.0-sl2569.17

8 months ago

1.10.0-release240425.31

8 months ago

1.10.0-sl2569.16

8 months ago

1.10.0-release240425.30

8 months ago

1.10.0-sl2569.15

8 months ago

1.10.0-sl2569.19

8 months ago

1.11.0

7 months ago

1.10.0-release240425.19

8 months ago

1.10.0-release240425.18

8 months ago

1.10.0-release240425.15

8 months ago

1.10.0-release240425.14

8 months ago

1.10.0-release240425.17

8 months ago

1.10.0-release240425.16

8 months ago

1.10.0-release240425.11

8 months ago

1.10.0-release240425.10

8 months ago

1.10.0-release240425.13

8 months ago

1.10.0-release240425.12

8 months ago

1.2.0-sl2399.0

1 year ago

1.10.0-release240425.66

8 months ago

1.10.0-release240425.65

8 months ago

1.10.0-release240425.67

7 months ago

1.10.0-release240425.62

8 months ago

1.10.0-release240425.61

8 months ago

1.6.0-commerce.scs2173.9

10 months ago

1.10.0-release240425.64

8 months ago

1.10.0-release240425.63

8 months ago

1.6.0-commerce.scs2173.6

11 months ago

1.6.0-commerce.scs2173.5

11 months ago

1.10.0-release240425.60

8 months ago

1.6.0-commerce.scs2173.8

10 months ago

1.6.0-commerce.scs2173.4

11 months ago

1.9.1

9 months ago

1.9.0

9 months ago

1.10.0-release240425.48

8 months ago

1.10.0-sl2569.10

8 months ago

1.10.0-release240425.47

8 months ago

1.10.0-release240425.49

8 months ago

1.10.0-release240425.44

8 months ago

1.10.0-release240425.43

8 months ago

1.10.0-release240425.46

8 months ago

1.10.0-release240425.45

8 months ago

1.10.0-release240425.40

8 months ago

1.10.0-release240425.42

8 months ago

1.10.0-release240425.41

8 months ago

1 year ago

1 year ago

1 year ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

1.10.0-release240425.59

8 months ago

1.10.0-sl2569.3

8 months ago

1.10.0-release240425.58

8 months ago

1.10.0-sl2569.2

8 months ago

1.10.0-sl2569.1

8 months ago

1.10.0-sl2569.0

8 months ago

1.10.0-release240425.55

8 months ago

1.10.0-release240425.54

8 months ago

1.10.0-release240425.57

8 months ago

1.10.0-release240425.56

8 months ago

1.10.0-release240425.51

8 months ago

1.10.0-release240425.50

8 months ago

1.10.0-release240425.53

8 months ago

1.10.0-release240425.52

8 months ago

1.8.1

10 months ago

1.8.0

10 months ago

1.6.0-commerce.0

12 months ago

1.4.0-commerce.SCS-2157.0

12 months ago

1 year ago

1 year ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

6 months ago

6 months ago

6 months ago

1 year ago

10 months ago

8 months ago

8 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1.1.3-commerce.scs1998.3

1 year ago

1.1.3-SL-2078.10

1 year ago

1.1.3-commerce.scs1998.2

1 year ago

1.1.3-commerce.scs1998.1

1 year ago

1.1.3-commerce.scs1998.0

1 year ago

1.1.3-commerce.scs1825.8

1 year ago

1.1.3-commerce.scs1825.1

1 year ago

1.1.3-commerce.scs1825.2

1 year ago

1.1.3-commerce.scs1825.3

1 year ago

1.1.3-commerce.scs1825.4

1 year ago

1.1.3-commerce.scs1825.5

1 year ago

1.1.3-commerce.scs1825.6

1 year ago

1.1.3-commerce.scs1825.7

1 year ago

1.1.3-commerce.scs1825.0

1 year ago

1.1.3-commerce.scs1825

1 year ago

1.0.0

2 years ago

1.1.2-loyalty.sl1715.11

1 year ago

1.1.2-loyalty.sl1715.12

1 year ago

1.1.1-loyalty.sl1715

1 year ago

1.1.1-sl1964.11

1 year ago

1.1.1-sl1964.10

1 year ago

1.1.2-loyalty.sl1715.10

1 year ago

1.1.2-loyalty.sl1715.13

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1.1.2-loyalty.sl1694b.0

1 year ago

1.1.2-loyalty.sl1694b.1

1 year ago

1.0.0-SL.1698.0

2 years ago

1.1.1-loyalty.sl1715.0

1 year ago

1.1.0-loyalty.0

2 years ago

1.1.1-loyalty.sl1715.2

1 year ago

1.1.1-loyalty.sl1715.1

1 year ago

1.1.2-loyalty.sl1715.8

1 year ago

1.1.2-loyalty.sl1715.9

1 year ago

1.1.2-scs1825.1

1 year ago

1.1.2-loyalty.sl1715.6

1 year ago

1.1.2-scs1825.0

1 year ago

1.1.2-loyalty.sl1715.7

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1.1.2-loyalty.sl1694b.4

1 year ago

1.1.2-loyalty.sl1715.0

1 year ago

1.1.2-loyalty.sl1694b.5

1 year ago

1.1.2-loyalty.sl1715.1

1 year ago

1.1.0-loyalty.sl1856

1 year ago

1.1.2-loyalty.sl1694b.2

1 year ago

1.1.2-loyalty.sl1694b.3

1 year ago

1.1.2-loyalty.sl1715.4

1 year ago

1.1.2-loyalty.sl1715.5

1 year ago

1.1.2-loyalty.sl1694b.6

1 year ago

1.1.2-loyalty.sl1715.2

1 year ago

1.1.2-loyalty.sl1694b.7

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1.1.0-loyalty.sl1856.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1.1.2-loyalty.sl-1694.3

1 year ago

1.1.2-loyalty.sl-1694.4

1 year ago

1.1.1-loyalty.SL-1964.7

1 year ago

1.1.2-loyalty.sl-1694.1

1 year ago

1.1.2-loyalty.sl-1694.2

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago