|
|
6 years ago | |
|---|---|---|
| .. | ||
| dist | set up common to use babel, static file serving middleware | 6 years ago |
| public | change isRecord to isModel | 6 years ago |
| scripts | removed generators, added simple presets to standard components | 6 years ago |
| src | removed generators, added simple presets to standard components | 6 years ago |
| .gitignore | bootstrap components started... | 7 years ago |
| README.md | bootstrap components started... | 7 years ago |
| components.json | removed generators, added simple presets to standard components | 6 years ago |
| package.json | publish | 6 years ago |
| rollup.config.js | running prettier over codebase, removing merge files | 6 years ago |
| rollup.testconfig.js | running prettier over codebase, removing merge files | 6 years ago |
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
degitso that it automates some of the setup work
Setting up
- Run
npm init(oryarn 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.