budibase/packages/materialdesign-components
Martin McKeaveney 270428bd13 adding electron to dev deps 2020-07-09 11:38:07 +01:00
..
public MD Button, Icon and Font Changes 2020-04-02 12:56:21 +01:00
src removal of appRoot - appId comes in cookie 2020-06-12 20:42:55 +01:00
.gitignore All latest changes coming from the builder testing 2020-04-14 14:15:32 +01:00
.npmignore prep for NPM publish 2020-02-26 22:18:14 +00:00
README.md MD components library - empty proj (#61) 2020-01-27 10:59:56 +00:00
components.json Basic Card and Component Tidyup 2020-04-22 11:52:55 +01:00
package.json adding electron to dev deps 2020-07-09 11:38:07 +01:00
rollup.config.js All latest changes coming from the builder testing 2020-04-14 14:15:32 +01:00
rollup.testconfig.js eslint tidy up 2020-02-25 15:46:04 +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.