diff --git a/README.md b/README.md index ba7027cb..81b3cd62 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Reusable Svelte components for some internal applications ## installation -To install to your Svelte project, open your project's root directory in a terminal. Type or paste `npm i -D @silintl/ui-components` and press enter. Sass (depending on your bundler and plugins) and material-components-web are required to develop additional material web components in your app, but it may depend on your version of npm if they are necessary even if you don't (I haven't figured out which versions require them). Enter the commands `npm i -D material-components-web@14` and `npm i -D sass@1` (versions will vary if you use an older release of this library). You should already have svelte@3 installed if you are using this library. +To install to your Svelte project, open your project's root directory in a terminal. Type or paste `npm i -D @silintl/ui-components` and press enter. Sass (depending on your bundler and plugins) and material-components-web are required to develop additional material web components in your app, but it may depend on your version of npm if they are necessary even if you don't (I haven't figured out which versions require them). Enter the commands `npm i -D material-components-web@14` and `npm i -D sass@1` (versions will vary if you use an older release of this library). You should already have svelte@4 installed if you are using this library. If you are using typescript you will need to run `npm i -D tslib` to avoid a material-components-web type error. This will already be installed if you have set up SvelteKit with typescript using `npm create svelte@latest app-name`. @@ -69,7 +69,7 @@ and then import it to your sass entry point like \_index.scss. You may prefer to SvelteKit won't need a bundler as it uses Vite, but Svelte projects will need a bundler (rollup or webpack most likely) configuration. If you are using rollup your plugins in your "rollup.config.js" should look something like this taking special note of postcss and svelte: -``` +```js import postcss from 'rollup-plugin-postcss'; import autoPreprocess from 'svelte-preprocess'; diff --git a/package.json b/package.json index b4946c07..68ab6cc6 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,7 @@ "prettier-plugin-svelte": "^3.2.2", "react": "^18.2.0", "react-dom": "^18.2.0", - "sass": "1.55.x", + "sass": "1.71.x", "semantic-release": "^19.0.5", "storybook": "^7.6.17" } diff --git a/stories/Item.stories.svelte b/stories/Item.stories.svelte index c077738b..9f5cab5d 100644 --- a/stories/Item.stories.svelte +++ b/stories/Item.stories.svelte @@ -1,5 +1,5 @@