https://github.com/patrickroberts/svelte-ts-component-template
A Svelte component library template with TypeScript support
https://github.com/patrickroberts/svelte-ts-component-template
Last synced: 7 months ago
JSON representation
A Svelte component library template with TypeScript support
- Host: GitHub
- URL: https://github.com/patrickroberts/svelte-ts-component-template
- Owner: patrickroberts
- Created: 2020-07-18T19:10:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-13T18:16:32.000Z (over 4 years ago)
- Last Synced: 2024-11-15T04:54:15.237Z (7 months ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# svelte-ts-component-template
A base for building shareable Svelte components. Clone it with [degit](https://github.com/Rich-Harris/degit):
```bash
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](https://github.com/sveltejs/rollup-plugin-svelte) or [svelte-loader](https://github.com/sveltejs/svelte-loader) (where [`resolve.mainFields`](https://webpack.js.org/configuration/resolve/#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.