1
0
Fork 0
mirror of synced 2024-09-28 07:11:40 +12:00
budibase/packages/standard-components
Martin McKeaveney 79c9df6ea2 v0.4.2
2020-12-15 15:23:45 +00:00
..
public
scripts
src Merge pull request #903 from Budibase/feature/security-update 2020-12-15 09:52:18 +00:00
.gitignore
.npmignore
components.json changes settings prop of card link color 2020-12-09 13:21:04 +01:00
LICENSE
package.json v0.4.2 2020-12-15 15:23:45 +00:00
README.md
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

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.