Merge branch 'master' of https://github.com/chakra-ui/chakra-ui-vue

quangtynu · Mar 15, 2020 · c3abb10 · c3abb10
2 parents 7b0eaf7 + 063f08d
commit c3abb10
Show file tree

Hide file tree

Showing 7 changed files with 117 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -5,16 +5,18 @@
 
 <p align="center">
   <a href="https://github.com/chakra-ui/chakra-ui-vue">
-    <img src="https://res.cloudinary.com/xtellar/image/upload/v1584203487/chakra-ui/chakra-ui-vue.png" alt="chakra-ui symbol" width="300" />
+    <img src="https://res.cloudinary.com/xtellar/image/upload/v1584242872/chakra-ui/chakra-ui-vue-beta.png" alt="chakra-ui symbol" width="300" />
   </a>
 </p>
 
 <h2 align="center">Build scalable and accessible Vue.js applications with ease.</h2>
 
-**@chakra-ui/vue** gives you a set of accessible and composable Vue components that you can use to build your favourite applications and sites.
+**chakra-ui-vue** gives you a set of accessible and composable Vue components that you can use to build your favourite applications and sites.
 
 > Hello, friend! 😄
-> **@chakra-ui/vue** is currently under development. A more detailed documentation site is in the pipeline soon! Check out our [storybook]() and [Codesandbox Vue & Nuxt Starters](https://codesandbox.io/s/chakra-ui-vue-starter-2sy0g).
+> **chakra-ui-vue** is currently under development. Majority of all the components ready and can be used!
+> 
+> A more detailed documentation site is in the pipeline and will be released soon! Check out our [storybook](https://chakra-ui-vue.netlify.com) and [Codesandbox Vue & Nuxt Starters](#codesandbox-starters).
 
 ## Features
 
@@ -26,6 +28,20 @@
   specifications and have the right `aria-*` attributes.
 - **Dark Mode 😍**: Most components in Chakra UI are dark mode compatible.
 
+### Table of Contents
+1. [Installation](#installation)
+2. [Usage](#usage)
+   a. [With Nuxt](#nuxt-usage)
+- [Features](#features)
+  - [Table of Contents](#table-of-contents)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Codesandbox starters](#codesandbox-starters)
+  - [Storybook Components](#storybook-components)
+  - [Development for Contributing:](#development-for-contributing)
+    - [Project TODOs:](#project-todos)
+- [Contributors ✨](#contributors-%e2%9c%a8)
+
 ## Installation
 ```bash
 yarn add @chakra-ui/vue emotion
@@ -35,6 +51,14 @@ or
 npm install @chakra-ui/vue emotion
 ```
 
+<a id="nuxt-usage"></a>
+>**Note:**
+If you're using Nuxt, you need to install `@nuxtjs/emotion` package as well to server-side render your styles.
+
+```bash
+yarn add @chakra-ui/vue emotion @nuxtjs/emotion
+```
+
 ## Usage
 **1. Import the Chakra UI plugin in your `main.js` file.**
 
@@ -53,7 +77,7 @@ new Vue({
 ```
 **2. Wrap your application inside the Chakra `ThemeProvider`.** We also recommend that you include the `CSSReset` component to normalize all browser styling.
 
-_In the `App.vue` file._
+_In your `App.vue` file._
 ```html
 <template>
   <ThemeProvider>
@@ -113,28 +137,27 @@ export default {
 </script>
 ```
 
-### chakra-ui/vue Codesandbox starters
-- [**_Vue Starter_**](https://codesandbox.io/s/chakra-ui-vue-starter-2sy0g)
-- [**_Nuxt Starter_**](https://codesandbox.io/s/chakra-ui-nuxt-demo-f8tq4)
+### Codesandbox starters
+- [Vue Starter](https://codesandbox.io/s/chakra-ui-vue-starter-2sy0g)
+- [Nuxt Starter](https://codesandbox.io/s/chakra-ui-nuxt-demo-f8tq4)
 
 ### Storybook Components
-You can also view all developed components in [Storybook](https://chakra-ui-vue.netlify.com)!
+You can also view all developed components in **[Storybook](https://chakra-ui-vue.netlify.com)!**
 
 ### Development for Contributing:
-Interested in contributing? See our open issues! Remember to take a look at our CONTRIBUTORS guide.
+Interested in contributing? See our open issues! Remember to take a look at our [CONTRIBUTORS](../../.github/CONTRIBUTING.md) guide.
 
 ```bash
 yarn install
 yarn bootstrap
 yarn dev
 ```
 
-
 #### Project TODOs:
 - [ ] Documentation site (Ongoing)
 - [ ] Set up type system for plugin & components export with Typescript
 
-
+<a id="contributors"></a>
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

diff --git a/packages/chakra-ui-core/CHANGELOG.md b/packages/chakra-ui-core/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.2.3](https://github.com/chakra-ui/chakra-ui-vue/compare/@chakra-ui/vue@0.2.2...@chakra-ui/vue@0.2.3) (2020-03-15)
+
+**Note:** Version bump only for package @chakra-ui/vue
+
+
+
+
+
 ## [0.2.2](https://github.com/chakra-ui/chakra-ui-vue/compare/@chakra-ui/vue@0.2.1...@chakra-ui/vue@0.2.2) (2020-03-14)
 
 **Note:** Version bump only for package @chakra-ui/vue

diff --git a/packages/chakra-ui-core/README.md b/packages/chakra-ui-core/README.md
@@ -5,7 +5,7 @@
 
 <p align="center">
   <a href="https://github.com/chakra-ui/chakra-ui-vue">
-    <img src="https://res.cloudinary.com/xtellar/image/upload/v1584203487/chakra-ui/chakra-ui-vue.png" alt="chakra-ui symbol" width="300" />
+    <img src="https://res.cloudinary.com/xtellar/image/upload/v1584242872/chakra-ui/chakra-ui-vue-beta.png" alt="chakra-ui symbol" width="300" />
   </a>
 </p>
 
@@ -14,7 +14,9 @@
 **chakra-ui-vue** gives you a set of accessible and composable Vue components that you can use to build your favourite applications and sites.
 
 > Hello, friend! 😄
-> **chakra-ui-vue** is currently under development. A more detailed documentation site is in the pipeline soon! Check out our [storybook]() and [Codesandbox Vue & Nuxt Starters](https://codesandbox.io/s/chakra-ui-vue-starter-2sy0g).
+> **chakra-ui-vue** is currently under development. Majority of all the components ready and can be used!
+> 
+> A more detailed documentation site is in the pipeline and will be released soon! Check out our [storybook](https://chakra-ui-vue.netlify.com) and [Codesandbox Vue & Nuxt Starters](#codesandbox-starters).
 
 ## Features
 
@@ -26,6 +28,20 @@
   specifications and have the right `aria-*` attributes.
 - **Dark Mode 😍**: Most components in Chakra UI are dark mode compatible.
 
+### Table of Contents
+1. [Installation](#installation)
+2. [Usage](#usage)
+   a. [With Nuxt](#nuxt-usage)
+- [Features](#features)
+  - [Table of Contents](#table-of-contents)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Codesandbox starters](#codesandbox-starters)
+  - [Storybook Components](#storybook-components)
+  - [Development for Contributing:](#development-for-contributing)
+    - [Project TODOs:](#project-todos)
+- [Contributors ✨](#contributors-%e2%9c%a8)
+
 ## Installation
 ```bash
 yarn add @chakra-ui/vue emotion
@@ -35,6 +51,14 @@ or
 npm install @chakra-ui/vue emotion
 ```
 
+<a id="nuxt-usage"></a>
+>**Note:**
+If you're using Nuxt, you need to install `@nuxtjs/emotion` package as well to server-side render your styles.
+
+```bash
+yarn add @chakra-ui/vue emotion @nuxtjs/emotion
+```
+
 ## Usage
 **1. Import the Chakra UI plugin in your `main.js` file.**
 
@@ -113,15 +137,15 @@ export default {
 </script>
 ```
 
-### chakra-ui/vue Codesandbox starters
-- [**_Vue Starter_**](https://codesandbox.io/s/chakra-ui-vue-starter-2sy0g)
-- [**_Nuxt Starter_**](https://codesandbox.io/s/chakra-ui-nuxt-demo-f8tq4)
+### Codesandbox starters
+- [Vue Starter](https://codesandbox.io/s/chakra-ui-vue-starter-2sy0g)
+- [Nuxt Starter](https://codesandbox.io/s/chakra-ui-nuxt-demo-f8tq4)
 
 ### Storybook Components
-You can also view all developed components in [Storybook](https://chakra-ui-vue.netlify.com)!
+You can also view all developed components in **[Storybook](https://chakra-ui-vue.netlify.com)!**
 
 ### Development for Contributing:
-Interested in contributing? See our open issues! Remember to take a look at our CONTRIBUTORS guide.
+Interested in contributing? See our open issues! Remember to take a look at our [CONTRIBUTORS](../../.github/CONTRIBUTING.md) guide.
 
 ```bash
 yarn install
@@ -133,7 +157,7 @@ yarn dev
 - [ ] Documentation site (Ongoing)
 - [ ] Set up type system for plugin & components export with Typescript
 
-
+<a id="contributors"></a>
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

diff --git a/packages/chakra-ui-core/package.json b/packages/chakra-ui-core/package.json
@@ -1,25 +1,29 @@
 {
   "name": "@chakra-ui/vue",
-  "version": "0.2.2",
-  "description": "Build Accessible and Scalable Vue.js applications with ease",
-  "author": "Jonathan Bakebwa <jonas@akkadu-team.com>",
-  "license": "MIT",
+  "version": "0.2.3",
+  "description": "Build Accessible and Resonsible Vue.js applications with ease",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "unpkg": "dist/umd/index.min.js",
   "sideEffects": false,
+  "maintainers": [
+    "Jonathan Bakebwa <jonas@akkadu-team.com>"
+  ],
+  "author": "Jonathan Bakebwa <jonas@akkadu-team.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/chakra-ui/chakra-ui-vue",
+  "repository": "https://github.com/chakra-ui/chakra-ui-vue",
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "yarn clean && rollup -c && rollup -c --environment MINIFY",
     "dev": "rollup --config rollup.dev.config.js --watch",
     "test": "echo testing ...",
     "clean": "rm -rf ./dist"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "dependencies": {
     "@styled-system/css": "^5.0.23",
@@ -42,5 +46,18 @@
   "devDependencies": {
     "core-js": "^3.4.5"
   },
+  "keywords": [
+    "vue",
+    "ui",
+    "design-system",
+    "vue-components",
+    "uikit",
+    "accessible",
+    "components",
+    "emotion",
+    "library",
+    "styled-system",
+    "kittens ;)"
+  ],
   "gitHead": "cb7ffb7adeb926b99c75f195300d09780e8910e6"
 }
diff --git a/packages/chakra-ui-core/rollup.config.js b/packages/chakra-ui-core/rollup.config.js
@@ -70,7 +70,13 @@ const commons = {
   ]
 }
 
-const bannerTxt = `/*! Chakra-ui/vue v${pkg.version} | MIT License | github.com/codebender828/kiwi-ui */`
+const bannerTxt = `
+/*
+ * ! @chakra-ui/vue v${pkg.version} by Jonathan Bakebwa @codebender828
+ * MIT License
+ * https://github.com/chakra-ui/chakra-ui-vue
+ */
+`
 
 const baseFolder = './src/'
 

diff --git a/packages/chakra-ui-docs/CHANGELOG.md b/packages/chakra-ui-docs/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.1.2](https://github.com/chakra-ui/chakra-ui-vue/compare/chakra-ui-docs@0.1.1...chakra-ui-docs@0.1.2) (2020-03-15)
+
+**Note:** Version bump only for package chakra-ui-docs
+
+
+
+
+
 ## [0.1.1](https://github.com/codebender828/kiwi-ui/compare/chakra-ui-docs@0.1.0...chakra-ui-docs@0.1.1) (2020-03-14)
 
 **Note:** Version bump only for package chakra-ui-docs

diff --git a/packages/chakra-ui-docs/package.json b/packages/chakra-ui-docs/package.json
@@ -1,9 +1,9 @@
 {
   "name": "chakra-ui-docs",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Chakra UI Vue documentation site",
   "author": "codebender828",
-  "private": false,
+  "private": true,
   "scripts": {
     "dev": "nuxt",
     "build": "nuxt build",