budibase/packages/standard-components
mike12345567 905cbc00e3 Merge branch 'master' of github.com:Budibase/budibase into version-complibrary 2020-10-21 15:33:23 +01: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 Allow binding images to attachment types 2020-10-20 12:23:52 +01:00
.gitignore Merge branch 'master' into removing-uikit-05 2020-09-04 21:45:33 +01:00
.npmignore
README.md
components.json Make detail column sticky and left orientated and fix crash with options inside grid 2020-10-16 12:55:20 +01:00
package.json Merge branch 'master' of github.com:Budibase/budibase into version-complibrary 2020-10-21 15:33:23 +01:00
rollup.config.js Don't run terser in standard components in dev mode 2020-10-15 09:04:57 +01:00
rollup.testconfig.js

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.