https://github.com/eswat2/s4e-icons

prototype Icon component library for Svelte...
https://github.com/eswat2/s4e-icons

material-design npm-package s4e-icons svelte svelte3 svg-icons

Last synced: 29 days ago
JSON representation

prototype Icon component library for Svelte...

• Host: GitHub
• URL: https://github.com/eswat2/s4e-icons
• Owner: eswat2
• Created: 2020-01-23T02:55:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T15:39:50.000Z (about 1 month ago)
• Last Synced: 2024-10-03T18:01:15.177Z (about 1 month ago)
• Topics: material-design, npm-package, s4e-icons, svelte, svelte3, svg-icons
• Language: Svelte
• Homepage: https://www.npmjs.com/package/s4e-icons
• Size: 801 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-template.md

Awesome Lists containing this project

README

        
*Psst — looking for an app template? Go here --> [sveltejs/template](https://github.com/sveltejs/template)*

---

# component-template

A base for building shareable Svelte components. Clone it with [degit](https://github.com/Rich-Harris/degit):

```bash

npx degit sveltejs/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.js` 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.js`, 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.