budibase/packages/standard-components
Andrew Kingston 33e2ee427d Replace all manual API interaction with SDK 2020-11-12 12:24:45 +00:00
..
public
scripts Linting. 2020-10-21 15:29:13 +01:00
src Replace all manual API interaction with SDK 2020-11-12 12:24:45 +00:00
.gitignore
.npmignore
README.md
components.json Add colour palette options for charts 2020-11-05 13:37:28 +00:00
package.json v0.3.6 2020-11-09 18:16:36 +00:00
rollup.config.js Remove unecessary lodash import 2020-11-04 14:22:04 +00:00
rollup.testconfig.js bump rollup plugin svelte version 2020-11-09 18:04:55 +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.