18.7.0 • Published 1 year ago

@ezcater/recipe v18.7.0

Weekly downloads
1,377
License
MIT
Repository
github
Last release
1 year ago

Installation

npm install @ezcater/recipe --save

Importing components in downstream projects

Import the Recipe package, just as you would any other package dependency:

import {EzButton} from '@ezcater/recipe';

export const MyComponent = () => (
  <div>
    <EzButton use="primary" onClick={() => alert('You clicked me!')}>
      Click Me!
    </EzButton>
  </div>
);

Contributing / Creating Components

This project uses plop to generate new React components. The functionality is exposed as the create-component npm script from package.json. This will:

  • copy the component template files from templates/component to src/components/YOUR_COMPONENT_NAME,
  • rename all files to match your component's name
  • replace all occurrences of Component inside the component's files with your component's name.

To create a new component, run npm run create-component inside the project. You'll see a CLI that guides you through the process.

After the CLI has finished, all files will have been created in the location you specified. You'll need to add an export for your component to src/index.tsx. For example:

// inside src/index.tsx
export {default as EzButton} from './components/EzButton';

Developing

Use the npm start command when making edits to recipe to accomplish the following:

  • Run npm run build:watch; this will recompile any changes made to recipe components
  • Automatically link the local recipe directory to the documentation site
  • Run gatsby develop; this will start up the documentation website and recompile when there are changes to either the recipe or documentation codebase

Publishing

After contributing updates to recipe, you'll need to publish the recipe package for changes to take effect in downstream projects (like ezmanage). To publish, you need to:

  • make sure your source is up-to-date and have run npm install from packages/recipe
  • bump the package version number in packages/recipe/package.json (and lock file) by running npm version patch
  • run npm run build to locally build with the latest version that you wish to publish.
  • run npm publish to publish the new version of recipe to npm
  • run npm install @ezcater/recipe --save from the downstream project (e.g. to install the latest version of recipe in ezmanage)
  • run npm run deploy from /doc-site to ensure the documentation site reflects your changes
  • create a PR for the downsteam project

License

Recipe is licensed under the MIT license.

18.2.1

1 year ago

18.2.0

1 year ago

18.1.0

1 year ago

18.0.1

1 year ago

18.0.0

1 year ago

18.6.0

1 year ago

17.7.0

1 year ago

18.5.0

1 year ago

17.8.0

1 year ago

18.4.1

1 year ago

18.4.0

1 year ago

17.10.0

1 year ago

17.5.0

1 year ago

18.3.1

1 year ago

18.3.0

1 year ago

17.6.0

1 year ago

17.9.0

1 year ago

18.7.0

1 year ago

17.4.0

1 year ago

17.3.0

2 years ago

17.3.2

2 years ago

17.3.1

2 years ago

17.1.0

2 years ago

16.3.1

2 years ago

16.3.0

2 years ago

17.2.1

2 years ago

17.2.0

2 years ago

17.0.1

2 years ago

17.0.0

2 years ago

16.2.1

2 years ago

16.2.0

2 years ago

16.1.1

2 years ago

16.1.0

2 years ago

16.1.2

2 years ago

15.2.0

2 years ago

15.2.1

2 years ago

15.2.2

2 years ago

15.2.3

2 years ago

16.0.1

2 years ago

16.0.0

2 years ago

15.0.0

2 years ago

15.1.0

2 years ago

14.0.5

3 years ago

14.0.4

3 years ago

14.0.0

3 years ago

14.0.1

3 years ago

14.0.2

3 years ago

14.0.3

3 years ago

13.1.1

3 years ago

13.1.0

3 years ago

13.2.0

3 years ago

12.5.0

3 years ago

13.0.2

3 years ago

13.0.3

3 years ago

13.0.0

3 years ago

13.0.1

3 years ago

12.4.0

3 years ago

12.4.1

3 years ago

12.4.2

3 years ago

12.3.0

3 years ago

12.2.0

3 years ago

12.1.0

3 years ago

12.0.3

4 years ago

12.0.4

4 years ago

12.0.5

4 years ago

12.0.0

4 years ago

12.0.1

4 years ago

12.0.2

4 years ago

0.0.0-canary.0

4 years ago

11.4.3

4 years ago

11.4.4

4 years ago

11.4.2

4 years ago

11.4.1

4 years ago

11.4.0

4 years ago

11.3.0

4 years ago

11.2.1

4 years ago

11.2.0

4 years ago

11.1.0-beta.0

4 years ago

11.1.0

4 years ago

11.0.2

4 years ago

11.0.0

4 years ago

11.0.1

4 years ago

11.0.0-beta.4

4 years ago

11.0.0-beta.2

4 years ago

11.0.0-beta.3

4 years ago

11.0.0-beta.1

4 years ago

11.0.0-beta.0

4 years ago

10.7.3

4 years ago

10.7.2

4 years ago

10.7.1

4 years ago

10.7.0

4 years ago

10.6.0

4 years ago

10.5.0

4 years ago

10.4.2

4 years ago

10.4.1

5 years ago

10.4.0

5 years ago

10.3.0

5 years ago

10.2.0

5 years ago

10.1.1

5 years ago

10.1.0

5 years ago

10.0.5

5 years ago

10.0.4

5 years ago

10.0.3

5 years ago

10.0.2

5 years ago

10.0.2-rc.0

5 years ago

10.0.1

5 years ago

10.0.1-alpha.6

5 years ago

10.0.1-alpha.3

5 years ago

10.0.1-alpha.4

5 years ago

10.0.1-alpha.5

5 years ago

10.0.1-alpha.2

5 years ago

10.0.1-alpha.1

5 years ago

10.0.0

5 years ago

8.0.3

5 years ago

10.0.0-alpha.1

5 years ago

10.0.0-alpha.0

5 years ago

8.0.2

5 years ago

8.0.1-beta.0

5 years ago

8.0.1

5 years ago

8.0.0

5 years ago

7.1.3

5 years ago

7.1.2

5 years ago

8.0.0-alpha.0

5 years ago

7.1.1

5 years ago

7.1.0

5 years ago

7.0.3

5 years ago

7.0.2

5 years ago

7.0.1

5 years ago

7.0.0

5 years ago

6.1.3

5 years ago

6.1.2

5 years ago

6.1.1

5 years ago

6.1.0

5 years ago

6.0.2

5 years ago

6.0.1

5 years ago

6.0.0

5 years ago

5.2.0

6 years ago

5.1.0

6 years ago

5.0.0

6 years ago

4.5.0

6 years ago

4.4.0

6 years ago

4.3.0

6 years ago

4.2.1

6 years ago

4.2.0

6 years ago

4.1.0

6 years ago

4.0.0

6 years ago

3.0.1

6 years ago

3.0.1-alpha.0

6 years ago

3.0.0

6 years ago

2.4.1

6 years ago

2.4.0

6 years ago

2.3.0

6 years ago

2.2.0

6 years ago

2.1.0

6 years ago

2.0.0

6 years ago

2.0.0-alpha.2

6 years ago

2.0.0-alpha.0

6 years ago

1.13.0

6 years ago

1.12.1

6 years ago

1.12.0

6 years ago

1.11.3

6 years ago

1.11.2

6 years ago

1.11.1

6 years ago

1.11.0

6 years ago

1.10.1

6 years ago

1.10.0

6 years ago

1.9.0

6 years ago

1.8.2

6 years ago

1.8.1

6 years ago

1.8.0

6 years ago

1.7.2

6 years ago

1.7.1

6 years ago

1.7.0

6 years ago

1.6.0

6 years ago

1.5.0

6 years ago

1.4.1

6 years ago

1.4.0

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.0

6 years ago

1.0.18

6 years ago

1.0.17

6 years ago

1.0.16

6 years ago

1.0.15

6 years ago

1.0.14

6 years ago

1.0.13

6 years ago

1.0.12

6 years ago

1.0.11

6 years ago

1.0.10

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago