History

Michael Shanks a67b812e52 standard-components - all files		2019-10-11 19:04:11 +01:00
..
dist	generators seem to be working...	2019-10-10 06:18:02 +01:00
public	generators..	2019-10-07 06:03:41 +01:00
scripts	generators..	2019-10-07 06:03:41 +01:00
src	few bug fixes	2019-10-10 10:41:31 +01:00
.gitignore	build app... probably not orking yet..	2019-09-07 06:50:35 +01:00
README.md	build app... probably not orking yet..	2019-09-07 06:50:35 +01:00
components.json	generators..	2019-10-07 06:03:41 +01:00
package.json	standard-components - all files	2019-10-11 19:04:11 +01:00
rollup.config.js	nav component and bug fixes	2019-09-26 05:40:58 +01:00
rollup.generatorsconfig.js	generators..	2019-10-07 06:03:41 +01:00
rollup.testconfig.js	context binding	2019-10-01 05:57:45 +01:00

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.html.

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.html, 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.