{"_id":"@abbychau/svelma","_rev":"1-a4d997d223d6f0e521e2c6667374b4f1","name":"@abbychau/svelma","dist-tags":{"latest":"0.4.1"},"versions":{"0.4.1":{"name":"@abbychau/svelma","svelte":"src/index.js","description":"Bulma components for Svelte","version":"0.4.1","author":{"name":"Abby Chau, Brian Hann"},"license":"MIT","keywords":["svelte","svelte.js","sveltejs","bulma","component","components"],"repository":{"type":"git","url":"git+https://github.com/abbychau/svelma.git"},"bugs":{"url":"https://github.com/abbychau/svelma/issues"},"module":"dist/module.js","main":"dist/index.js","peerDependencies":{"bulma":"^0.9.2"},"devDependencies":{"autoprefixer":"^10.2.5","bulma":"^0.9.2","conventional-changelog-cli":"^2.1.1","get-port-cli":"^2.0.0","node-sass":"^5.0.0","npm-run-all":"^4.1.5","postcss":"^8.2.8","prettier":"^2.2.1","prettier-plugin-svelte":"^2.2.0","rollup":"^2.41.4","rollup-plugin-alias":"^1.5.1","rollup-plugin-analyzer":"^4.0.0","rollup-plugin-bundle-size":"^1.0.3","rollup-plugin-commonjs":"^9.2.0","rollup-plugin-copy":"^3.4.0","rollup-plugin-css-only":"^3.1.0","rollup-plugin-livereload":"^2.0.0","rollup-plugin-node-resolve":"^4.0.1","rollup-plugin-scss":"^2.6.1","rollup-plugin-svelte":"^7.1.0","rollup-plugin-terser":"^7.0.2","semantic-release":"^17.4.2","sirv-cli":"^1.0.11","standard-version":"^9.1.1","svelte":"^3.35.0","svelte-preprocess":"^4.6.9","wait-for-localhost-cli":"^2.0.0"},"scripts":{"build":"rollup -c","autobuild":"rollup -c -w","dev":"run-p autobuild autodocs","docs":"(cd docs; npx sapper export --basepath svelma)","docs:deploy":"./docs.sh","autodocs":"(cd docs; npx sapper dev --basepath svelma)","jsdocs":"(cd docs; npx jsdoc -c jsdoc/conf.js)","prepublishOnly":"npm run build","postpublish":"npm run docs:deploy","changelog":"conventional-changelog -i CHANGELOG.md -p angular","semantic-release":"semantic-release"},"browserslist":"last 2 versions","homepage":"https://github.com/c0bra/svelma#readme","directories":{"doc":"docs"},"gitHead":"f7555b4d297d1fd91bb0fdc868ec00173c6e5b4d","_id":"@abbychau/svelma@0.4.1","_nodeVersion":"15.10.0","_npmVersion":"7.6.3","dist":{"integrity":"sha512-97b22g6gZRRCll3uNGEVJRjH0j27S74Z3lXHkPWCYiEc9KBfyY0FKYPf7t9bjpzCSnoaD0vjG/qVUzhpx0FAEg==","shasum":"c3d1474561f68cb99dfed1916391dcca9b01621b","tarball":"https://registry.npmjs.org/@abbychau/svelma/-/svelma-0.4.1.tgz","fileCount":42,"unpackedSize":657365,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgUjiVCRA9TVsSAnZWagAAzQoP/1VijxA7ZMYipS7RsCJu\nL3XATlAj6orbQ3jhU/nSwb7NWpjZChqyw9bpet/pLJz8hE2FX9gTexPetxhS\n0CjmN6e/NDPD31Tk+XL1DNc+ZGyziFrDetZ7ZkxmowOtLV4aZy4GNFld43m9\njI7i2Bj2G3zunbsouhIN0a63x8cCe2NknVaSRfAVbE4Vk1YaqO7smEqji2es\nC5RRh44XhB9XvyzoCFW/wIn7wxbSo3JURXbzE8dRbHLqBwqFY3F8KVuXb9d6\nyelJtI2/aP/mg3uhjbnrPy4hDJblyTRWaHYn4ZKdE0v/U6z11MT7XOv0a/Q5\nf8QzI9yLLi2liQSFq/hC1SeMxUKPSCjOSra6exyeI+S0sMqISRfkf+lcs94S\nudSVUFhY1axRWoLfUo8iAs1an+xPlL7ZZu4kjGR02HsnWeKFBBmH2nUHtURI\njfSeQvNDKE2u2xC+9Nn/k3GsVBhrsO2cLpgK7YCAS5KiC2EylvQnvfiglP19\nzkKsbLQZpwei7DBpFudR9W40ZVKEuFaHaFhLCiAc4HEGVQ+kpyDQkDHT6R0+\nMSOr6W+F3a3AHZG7Hk1JgWVG9dSMTM3MbPpFynBtRsOfWsFR8vj2BZL80krT\nQL++ahUFyHasqb8ExWe/aGXhRAKbKmjZJWsb1YszGqlQ35HXHfveS1ih8iSb\nvijE\r\n=J/xa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEGrxlTWfqheLyzCPaoNrqMoCK3cqX658gfsN6wjPwnkAiEA1nsgWZdy3R+LHgGNIFae9D1okWzUJwgZfbzb3Qsin4c="}]},"_npmUser":{"name":"abbychau","email":"abbychau@gmail.com"},"maintainers":[{"name":"abbychau","email":"abbychau@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svelma_0.4.1_1616001172945_0.7589934872569433"},"_hasShrinkwrap":false}},"time":{"created":"2021-03-17T17:12:52.887Z","0.4.1":"2021-03-17T17:12:53.189Z","modified":"2022-04-04T10:57:12.971Z"},"maintainers":[{"name":"abbychau","email":"abbychau@gmail.com"}],"description":"Bulma components for Svelte","homepage":"https://github.com/c0bra/svelma#readme","keywords":["svelte","svelte.js","sveltejs","bulma","component","components"],"repository":{"type":"git","url":"git+https://github.com/abbychau/svelma.git"},"author":{"name":"Abby Chau, Brian Hann"},"bugs":{"url":"https://github.com/abbychau/svelma/issues"},"license":"MIT","readme":"# Svelma\r\n\r\n> Svelma is a set of UI components for [Svelte](https://svelte.dev) based on the [Bulma](http://bulma.io) CSS framework.\r\n\r\n<a href=\"https://www.npmjs.com/package/svelma\"><img src=\"https://img.shields.io/npm/v/svelma.svg\" /></a>\r\n<a href=\"https://www.npmjs.com/package/svelma\"><img src=\"https://img.shields.io/npm/l/svelma.svg\" /></a>\r\n<a href=\"https://bundlephobia.com/result?p=svelma\"><img src=\"https://badgen.net/bundlephobia/minzip/svelma\"></a>\r\n<a href=\"https://travis-ci.com/c0bra/svelma\"><img src=\"https://travis-ci.com/c0bra/svelma.svg?branch=master\"></a>\r\n\r\n<!-- <a href=\"https://circleci.com/gh/c0bra/svelma\"><img src=\"https://img.shields.io/circleci/project/c0bra/svelma/svelma.svg?style=flat-square\" /></a> -->\r\n<!-- <a href=\"https://codecov.io/gh/svelma/svelma\"><img src=\"https://img.shields.io/codecov/c/github/svelma/svelma.svg?style=flat-square\" /></a> -->\r\n\r\n# Inspiration\r\n\r\nMuch thanks to the [Buefy](https://buefy.org) project! It provided the inspiration and lots of code examples for Svelma.. If you like Vue.js and Bulma, check it out.\r\n\r\n# Features\r\n\r\n- Extremely lightweight thanks to Svelte, a compile-only javascript framework. The bundle is `50K` minified, `14K` gzipped.\r\n- Components can be used independently, so a modern tree-shaking bundler will reduce the final bundle size even further.\r\n- Svelma does not bundle Bulma, so you are free to include it in your project however you wish, themes and all.\r\n\r\n# Documentation\r\n\r\n[See docs + demos site here](https://c0bra.github.io/svelma)\r\n\r\n# Quick Start\r\n\r\n### 1. Create a svelte app from the template\r\n\r\n[https://github.com/sveltejs/template](sveltejs/template) is a template repo for svelte. [degit](https://www.npmjs.com/package/degit) will scaffold the repo for you:\r\n\r\n    $ npx degit sveltejs/template my-svelma-project\r\n    $ cd my-svelma-project\r\n    $ npm install\r\n\r\n_NOTE_: There are of course other ways to set up a project using svelte. This is just the quickest way to start.\r\n\r\n### 2. Install svelma and dependencies via npm\r\n\r\nNote that you'll need a CSS processing plugin for rollup so that you can import css files. Here we're using `rollup-plugin-postcss`. If you're going to use a\r\n`<link>` tag in your HTML you can skip the plugin and the `import ... css` statement below in step #2\r\n\r\n    $ npm install --save bulma svelma\r\n    $ npm install node-sass svelte-preprocess rollup-plugin-postcss --save-dev\r\n\r\nAdd the postcss plugin to your rollup config (I don't think the order really matters):\r\n\r\n```js\r\n// rollup.config.js\r\nimport postcss from 'rollup-plugin-postcss'\r\nimport preprocess from 'svelte-preprocess'\r\n\r\n// ...\r\n\r\nexport default {\r\n  // ...\r\n  plugins: [\r\n    svelte({\r\n      // ...\r\n      preprocess: preprocess()\r\n    }),\r\n\r\n    postcss(),\r\n  }\r\n}\r\n```\r\n\r\n### 3. Import Bulma's CSS and Svelma components\r\n\r\n```html\r\n<!-- App.svelte -->\r\n<script>\r\n  import 'bulma/css/bulma.css'\r\n  import { Button } from 'svelma'\r\n</script>\r\n\r\n<button type=\"is-primary\">I'm a Button!</button>\r\n```\r\n\r\n### 4. Include [Font Awesome](https://fontawesome.com/) icons\r\n\r\nFrom CDN in your HTML page:\r\n\r\n```html\r\n<link rel=\"stylesheet\" href=\"https://use.fontawesome.com/releases/v5.3.1/css/all.css\"></link>\r\n```\r\n\r\n...or as an npm package imported into your root component:\r\n\r\n    $ npm install --save @fortawesome/fontawesome-free\r\n\r\n```html\r\n<!-- App.svelte -->\r\n<script>\r\n  import 'bulma/css/bulma.css'\r\n  import '@fortawesome/fontawesome-free/css/all.css'\r\n</script>\r\n```\r\n\r\n### SSR\r\n\r\nIf you are doing server-side rendering with Sapper, you'll need to import the .svelte files directly so that your app can compile them, rather than importing from the compiled module.\r\n\r\ni.e.:\r\n\r\n```js\r\nimport Button from 'svelma/src/components/Button.svelte'\r\n```\r\n\r\ninstead of\r\n\r\n```js\r\nimport { Button } from 'svelma'\r\n```\r\n\r\n# Development\r\n\r\n1. Clone this repo: `git clone https://github.com/c0bra/svelma.git`\r\n2. Install dependencies:\r\n   1. `npm i && (cd docs; npm i)`\r\n   2. `npm install -g semantic-release-cli commitizen`\r\n3. Start the automated build and automated docs: `npm run dev`\r\n4. Open url that console prints in your browser\r\n\r\n## Commit\r\n\r\n    $ git cz\r\n\r\n# Publish\r\n\r\n_NOTE_: CI should publish new versions using `semantic-release` automatically\r\n\r\n```bash\r\n$ npm version <version>\r\n$ npm publish\r\n```\r\n\r\n# License\r\n\r\nCode released under MIT license.\r\n\r\nCopyright &copy;, Brian Hann.\r\n","readmeFilename":"README.md"}