budibase/packages/standard-components
Andrew Kingston 2cb4f1228a Merge branch 'master' of github.com:Budibase/budibase into stat-card 2020-12-04 09:00:43 +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 Merge branch 'master' of github.com:Budibase/budibase into stat-card 2020-12-04 09:00:43 +00:00
.gitignore Remove old test dir and add yarn lockfile 2020-12-01 10:47:48 +00:00
.npmignore prep for NPM publish 2020-02-26 22:18:14 +00:00
LICENSE Correct licenses 2020-11-24 16:04:44 +00:00
README.md build app... probably not orking yet.. 2019-09-07 06:50:35 +01:00
components.json Merge branch 'master' of github.com:Budibase/budibase into stat-card 2020-12-04 09:00:43 +00:00
package.json now uses RichText component in create/edit row modal on the backend 2020-12-03 15:37:04 +01:00
rollup.config.js lint fix 2020-12-03 15:39:24 +01:00
yarn.lock now uses RichText component in create/edit row modal on the backend 2020-12-03 15:37:04 +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.