budibase/packages/standard-components
Andrew Kingston 403223411d Fix missing bbui dependency from standard components 2020-09-08 16:47:38 +01:00
..
dist Merge branch 'master' into removing-uikit-05 2020-09-04 21:45:33 +01:00
public Various minor UI updates including the settings modal 2020-07-12 19:19:12 +01:00
scripts adding deploy script to upload assets to s3 after release 2020-08-20 11:09:54 +01:00
src Merge branch 'master' into removing-uikit-05 2020-09-04 21:45:33 +01:00
.gitignore Merge branch 'master' into removing-uikit-05 2020-09-04 21:45:33 +01:00
.npmignore prep for NPM publish 2020-02-26 22:18:14 +00:00
README.md build app... probably not orking yet.. 2019-09-07 06:50:35 +01:00
components.json Merging with master and fixing conflicts 2020-09-03 15:12:07 +01:00
package.json Fix missing bbui dependency from standard components 2020-09-08 16:47:38 +01:00
rollup.config.js Integration of Backend and Data Components 2020-08-26 17:03:30 +01:00
rollup.testconfig.js Work on Components API & bugfixes (#102) 2020-02-14 11:51:45 +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.