budibase/packages/standard-components
Martin McKeaveney 847d3ddd1e docs for release 2020-07-15 12:05:00 +01:00
..
dist
public Various minor UI updates including the settings modal 2020-07-12 19:19:12 +01:00
src Layout update 2020-07-14 14:52:11 +01:00
.gitignore
.npmignore
README.md
components.json Form: success notifier on save + configurable button text 2020-07-06 16:24:44 +01:00
package.json docs for release 2020-07-15 12:05:00 +01:00
rollup.config.js formatting 2020-05-18 11:01:17 +01:00
rollup.testconfig.js

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.