nfs-svelte-form-renderer

A Svelte component library template with TypeScript support

Usage no npm install needed!

<script type="module">
  import nfsSvelteFormRenderer from 'https://cdn.skypack.dev/nfs-svelte-form-renderer';
</script>

README

svelte-ts-component-template

A base for building shareable Svelte components. Clone it with degit:

npx degit patrickroberts/svelte-ts-component-template my-new-component
cd my-new-component
npm install # or yarn

Your component's source code lives in src/Component.svelte.

You can create a package that exports multiple components by adding them to the src directory and editing src/index.ts to reexport them as named exports.

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.ts, 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 (dist/index.mjs) and a UMD script (dist/index.js). This will happen automatically when you publish your component to npm, courtesy of the prepublishOnly hook in package.json.