MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
budibase/packages/materialdesign-components
History
Michael Shanks 4809105fc3 Merge branch 'master' of github.com:Budibase/budibase 2020-02-25 17:06:00 +00:00
..
dist running prettier over codebase, removing merge files 2020-02-03 09:24:25 +00:00
public Completed textfield, minor bug fixes and config changes to reference uncompiled components (#83) 2020-02-07 20:56:00 +00:00
scripts publishDev scripts create dirs, so we dont get annoying errors 2020-02-22 22:24:19 +00:00
src Merge branch 'master' of github.com:Budibase/budibase 2020-02-25 17:06:00 +00:00
.gitignore Config updates to add bundles to build folder so that index.html can be un-gitignored 2020-02-03 18:48:49 +00:00
README.md MD components library - empty proj (#61) 2020-01-27 10:59:56 +00:00
components.json record Form template 2020-02-21 22:56:37 +00:00
package.json Completed MD Menu component 2020-02-25 10:09:32 +00:00
rollup.config.js eslint tidy up 2020-02-25 15:46:04 +00: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.