Skip to content
A base for building shareable Svelte components
JavaScript HTML
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Use Svelte v3 Jul 12, 2019
.gitignore fix build, exclude build artifacts from repo Apr 3, 2018
README.md readme: update link to rollup-plugin-svelte Nov 25, 2019
package.json Use Svelte v3 Jul 12, 2019
rollup.config.js Use Svelte v3 Jul 12, 2019

README.md

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


component-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 src/index.svelte.

TODO

  • some firm opinions about the best way to test components
  • update degit so that it automates some of the setup work

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.svelte, 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 (index.mjs) and a UMD script (index.js). This will happen automatically when you publish your component to npm, courtesy of the prepublishOnly hook in package.json.

You can’t perform that action at this time.