History

Andrew Kingston ce18e253ba Remove deprecated props, fix warnings, remove old code		2020-11-30 15:05:36 +00:00
..
public	Changing record -> row in this update, completing the update of renaming in the builder, this release needs further testing.	2020-10-09 19:10:28 +01:00
scripts	Linting.	2020-10-21 15:29:13 +01:00
src	Remove deprecated props, fix warnings, remove old code	2020-11-30 15:05:36 +00:00
.gitignore	Merge branch 'master' into removing-uikit-05	2020-09-04 21:45:33 +01:00
.npmignore	…
LICENSE	Correct licenses	2020-11-24 16:04:44 +00:00
README.md	…
components.json	Remove deprecated props, fix warnings, remove old code	2020-11-30 15:05:36 +00:00
package.json	Merge branch 'master' of github.com:Budibase/budibase into component-sdk	2020-11-25 18:38:58 +00:00
rollup.config.js	Tidy up dependencies and rollup configs for client and standard components	2020-11-25 16:03:52 +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.