History

Michael Shanks 5ce66c2481 v0.0.18		2020-02-26 22:18:45 +00:00
..
dist	eslint tidy up	2020-02-25 15:46:04 +00:00
public	removed generators, added simple presets to standard components	2020-02-18 20:35:43 +00:00
scripts	publishDev scripts create dirs, so we dont get annoying errors	2020-02-22 22:24:19 +00:00
src	Update index.js	2020-02-25 17:30:27 +00:00
.gitignore	build app... probably not orking yet..	2019-09-07 06:50:35 +01:00
.npmignore	prep for NPM publish	2020-02-26 22:18:14 +00:00
README.md	build app... probably not orking yet..	2019-09-07 06:50:35 +01:00
components.json	state management bindings	2020-02-21 15:44:48 +00:00
package.json	v0.0.18	2020-02-26 22:18:45 +00:00
rollup.config.js	running prettier over codebase, removing merge files	2020-02-03 09:24:25 +00:00
rollup.testconfig.js	Work on Components API & bugfixes (#102 )	2020-02-14 11:51:45 +00: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.