## ๐ Installation ### JavaScript The Semantic UI Vue package can be installed via NPM/Yarn: ```bash $ npm install semantic-ui-vue # or $ yarn add semantic-ui-vue ``` Installing Semantic UI Vue provides the JavaScript for your components. You'll also need to include a stylesheet to provide the styling for your components. Once Semantic UI Vue has been installed, you will need to import it in your main file (usually `index.js` or `main.js`) and tell Vue to use it: ```js import Vue from 'vue'; import SuiVue from 'semantic-ui-vue'; /* ... */ Vue.use(SuiVue); ``` If you are not using Webpack, you can add the script in your html: ```html
``` Or, in alternative, you can import it using a CDN: ```html ``` Now you are ready to go! Check out the components' examples to see how to use them. ### CSS #### Content Delivery Network (CDN) You can use the default Semantic UI stylesheet by including a Semantic UI CDN link in your `index.html` file. This is the quickest way to get started with Semantic UI Vue. You **won't be able to use custom themes** with this method. > **To avoid unexpected behavior please use only the latest version of Semantic-UI** ```html ``` #### Semantic UI CSS package The Semantic UI CSS package is automatically synced with the main Semantic UI repository to provide a lightweight CSS only version of Semantic UI. Semantic UI CSS can be installed as a package in your project using NPM. You **won't be able to use custom themes** with this method. ```bash $ npm install semantic-ui-css --save # or $ yarn add semantic-ui-css ``` After install, you'll need to include the minified CSS file in your index.js file: ```js import 'semantic-ui-css/semantic.min.css'; ``` #### Semantic UI package Install the full Semantic UI package. Semantic UI includes Gulp build tools so your project can preserve its own theme changes, allowing you to customize the style variables. Detailed documentation on theming in Semantic UI is provided [here](https://semantic-ui.com/usage/theming.html). ```bash $ npm install semantic-ui --save-dev # or $ yarn add semantic-ui ``` After building the project with Gulp, you'll need to include the minified CSS file in your index.js file: ```js import '../semantic/dist/semantic.min.css'; ``` ### Nuxt.js module You can use semantic-ui-vue as [nuxt.js](https://github.com/nuxt/nuxt.js) module. Usage: - Install semantic-ui-vue and semantic-ui-css packages - Install semantic-ui-vue and semantic-ui-css packages - Add this into your nuxt.config.js file: ```js { modules: [ 'semantic-ui-vue/nuxt', // includes styles from semantic-ui-css ['semantic-ui-vue/nuxt', { css: false }], // if you have your own semantic-ui styles ]; } ``` ## ๐ค Contact us! Do you have a question? Do you want to submit a bug, or suggest an improvement? Please contact us! Especially at this stage, we really need this. To do so, do not hesitate to [join our chat on Gitter](https://gitter.im/Semantic-UI-Vue/Lobby), or [submit an issue](https://github.com/Semantic-UI-Vue/Semantic-UI-Vue/issues/new) (it doesn't have to be a bug). Read the [CONTRIBUTING.md](https://github.com/Semantic-UI-Vue/Semantic-UI-Vue/blob/master/CONTRIBUTING.md) for more details