budibase/packages/bootstrap-components
Michael Shanks 63c865ab7d basic cru app possible 2019-10-19 07:24:20 +01:00
..
dist basic cru app possible 2019-10-19 07:24:20 +01:00
public bootstrap components started... 2019-10-14 08:32:20 +01:00
scripts bootstrap components started... 2019-10-14 08:32:20 +01:00
src basic cru app possible 2019-10-19 07:24:20 +01:00
.gitignore bootstrap components started... 2019-10-14 08:32:20 +01:00
README.md bootstrap components started... 2019-10-14 08:32:20 +01:00
components.json basic cru app possible 2019-10-19 07:24:20 +01:00
package.json bootstrap components started... 2019-10-14 08:32:20 +01:00
rollup.config.js bootstrap components started... 2019-10-14 08:32:20 +01:00
rollup.generatorsconfig.js bootstrap components started... 2019-10-14 08:32:20 +01:00
rollup.testconfig.js bootstrap components started... 2019-10-14 08:32:20 +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.