budibase/packages/standard-components
Martin McKeaveney 2e6ed0bad9 v0.3.7 2020-11-10 20:23: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 Fixing #848 - standard components was not using the same API calls consistently which was breaking some things like charts. For now just make it consistent by updating it to make calls the same way as client lib does but the SDK will eventually replace all this and solve these problems. 2020-11-10 15:09:54 +00: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 Add colour palette options for charts 2020-11-05 13:37:28 +00:00
package.json v0.3.7 2020-11-10 20:23: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.