gc

gloubiboulga-components

Template for creating a svelte components library

Showing:

Popularity

Downloads/wk

0

GitHub Stars

40

Maintenance

Last Commit

1yr ago

Contributors

4

Package

Dependencies

0

License

ISC

Type Definitions

Tree-Shakeable

Yes?

Categories

Readme

Psst — looking for an app template? Go here --> sveltejs/template


svelt-component-library-template

A base for building shareable Svelte component library. Clone it with degit:

npx degit nirmaoz/svelte-component-library-template my-new-component
cd my-new-component
npm install # or yarn

Your component's source code lives in src/Component.svelte.

You can create a package that exports multiple components by adding them to the src directory and editing src/index.js to reexport them as named exports.

This template includes:

  • Svelte Component
  • Testing using svelte-testing-library + Jest
  • Storybook
  • Rollup, configured to build .js (umd), .min.js (iife), .mjs (es)

Setting up

  • Run npm init (or yarn init)
  • Replace this README with your own

Consuming components

Your package.json has a "svelte" field pointing to src/index.js, which allows Svelte apps to import the source code directly, if they are using a bundler plugin like rollup-plugin-svelte or svelte-loader (where resolve.mainFields in your webpack config includes "svelte"). This is recommended.

For everyone else, npm run build will bundle your component's source code into a plain JavaScript module (dist/index.mjs) and a UMD script (dist/index.js). This will happen automatically when you publish your component to npm, courtesy of the prepublishOnly hook in package.json.

Based on sveltejs/component-template

I couldn't find an opinionated components library template to my liking, so I used sveltejs/component-template as base. And then I added minified build configuration using terser plugin + tests + storybook.

Testing

Comes with tests out of the box using svelte-testing-library + Jest.

To Run tests:

npm test # or yarn

Storybook

To serve development build:

npm run storybook

To build static storybook site (default output folder is /docs for easly sharing on github pages):

npm run build-storybook

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100