Psst — looking for a more complete solution? Check out SvelteKit and its package command which gives you more built-in features like TypeScript transpilation, type definition generation and a built-in playground to test your library.
Looking for an app template instead? Go here --> sveltejs/template
A base for building shareable Svelte components. Clone it with degit:
npx degit sveltejs/component-template my-new-component cd my-new-component npm install # or yarn
Your component's source code lives in
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.
- some firm opinions about the best way to test components
degitso that it automates some of the setup work
- Replace this README with your own
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,
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.