@dialpad/dialtone-vue 1.7.0 → 1.8.2

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [1.8.2](https://github.com/dialpad/dialtone-vue/compare/v1.8.1...v1.8.2) (2022-01-06)
+
+
+### Bug Fixes
+
+* skeleton-text import ([#221](https://github.com/dialpad/dialtone-vue/issues/221)) ([ff6ca97](https://github.com/dialpad/dialtone-vue/commit/ff6ca978f20a20d8f160fecfde040deacdc735df))
+
+## [1.8.1](https://github.com/dialpad/dialtone-vue/compare/v1.8.0...v1.8.1) (2022-01-06)
+
+
+### Bug Fixes
+
+* bad exports on skeleton ([#220](https://github.com/dialpad/dialtone-vue/issues/220)) ([5b66ae7](https://github.com/dialpad/dialtone-vue/commit/5b66ae75c8034434b02f67b26f4fb9136966032e))
+
+# [1.8.0](https://github.com/dialpad/dialtone-vue/compare/v1.7.0...v1.8.0) (2022-01-04)
+
+
+### Bug Fixes
+
+* popover stories ([#216](https://github.com/dialpad/dialtone-vue/issues/216)) ([8229467](https://github.com/dialpad/dialtone-vue/commit/8229467b25342540163e61f8fc5797beb1e780b2))
+
+
+### Features
+
+* add keyboard shortcut component ([#209](https://github.com/dialpad/dialtone-vue/issues/209)) ([88efc48](https://github.com/dialpad/dialtone-vue/commit/88efc4882812d391bb9200c2c1f7cdb7dc56d5a9))
+* component skeleton ([#203](https://github.com/dialpad/dialtone-vue/issues/203)) ([ce2a4d2](https://github.com/dialpad/dialtone-vue/commit/ce2a4d21dc45924e0eec561299de768ba8ae5222))
+
 # [1.7.0](https://github.com/dialpad/dialtone-vue/compare/v1.6.1...v1.7.0) (2021-12-15)
 
 

package/README.md

@@ -5,8 +5,9 @@ Dialtone Vue is a library of Vue components for [Dialtone][dt]. The goal is to s
 **[Component Documentation Site ↗️][dialtone-vue]**
 
 [dt]: https://dialpad.design
+[dialtone-vue]: https://vue.dialpad.design
 
-### Project Status
+## Project Status
 
 Dialtone Vue is a new project, and as such it is under constant development as we add new components and refine existing ones. Please refer to the [jira board][jira] to see the status of Dialtone Vue components and request new components that should be in the Dialtone Vue library.
 
@@ -20,85 +21,7 @@ Dialtone Vue components can be imported directly from the package. Some componen
 import { DtInput, VALIDATION_MESSAGE_TYPES } from '@dialpad/dialtone-vue';
 ```
 
-## Storybook Component Documentation
-
-Dialtone Vue uses [Storybook][storybook] for documentation of components, as well as an environment for local development. Please see the [Storybook Documentation Site][dialtone-vue] for specific usage information and interactive documentation for each Dialtone Vue component.
-
-All components in Dialtone Vue should have stories written for them in Storybook. For more information on how to write stories, see the [documentation][stories].
-
-[storybook]: https://storybook.js.org
-[dialtone-vue]: https://vue.dialpad.design
-[stories]: https://vue.dialpad.design/?path=/story/docs-storybook-getting-started--page
-
-### Running Storybook Locally
-
-Storybook provides a sandbox to develop and experiment with components locally, in isolation from the rest of the app. With Storybook you get live reloading of component templates and styles, just like you would in the app. You can also test different props and slots and see the effects in real time, test accessibility issues, and more.
-
-To run Storybook locally, first install the dependencies:
-
-```
-npm run storybook:install
-```
-
-Then you can run the dev server:
-
-```
-npm run storybook
-```
-
-## Developing Dialtone Vue Components
-
-Building components for Dialtone Vue is similar to components for Dialpad or UberConference, but there are some differences. Remember that Dialtone Vue is a shared library so more care has to be taken to avoid breaking changes.
-
-Remember that Dialtone Vue is a separate project, so be sure to run the lint and unit tests for Dialtone Vue separately whenever making changes to the library.
-
-See [CONTRIBUTING](./CONTRIBUTING.md).
-
-### Project Setup
-
-#### Install Dependencies
-
-```bash
-npm install
-```
-
-### CSS & Dialtone
-
-Dialtone components should utilize the global immutable CSS classes provided by Dialtone whenever possible. It is a requirement of any project using Dialtone Vue to include these classes.
-
-If needed, you can also write custom CSS using Dialtone LESS variables by importing `../css/dialtone.less`.
-
-Please **do not** use any scoped CSS or mixins in Dialtone Vue components.
-
-### Unit Tests
-
-Each component should have a corresponding unit test in the `tests/specs` directory. There is no special test setup as Dialtone Vue components do not have access to the Vuex store or custom methods/directives.
-
-### Exports
-
-When adding a new component, please add its exports to `index.js`, including any named exports, so they're available for import to users of Dialtone Vue:
-
-```js
-export {
-  default as DtInput,
-  INPUT_SIZES,
-} from './components/input.vue';
-```
-
-### External Dependencies
-
-Dialtone Vue components are designed to be used in a variety of different projects. As such, Dialtone Vue components should be pure Vue components with no dependencies on global Vue plugins or stores, except when noted below. This in particular means:
-
-- **No access to the Vuex store.** Different projects will have different store structures, and so Dialtone Vue components cannot access the Vuex store. Dialtone Vue components should take data as props only.
-- **No I18n.** Each project will have its own i18n implementation. Any text needed in a Dialtone Vue component should be passed as props or slots.
-- **No custom directives.** Directives in Vue are installed globally and vary from project to project. Custom directives (such as `v-tooltip`) cannot be used in Dialtone Vue components.
-- **No other custom global methods.** Some projects may implement custom global methods on the Vue object. Dialtone Vue components are limited to the built-in Vue methods.
-- **No imports outside of the dialtone-vue directory.**
-- **Vue 2 compatibility.** Dialtone Vue components should ideally support Vue 2 and 3, but a minimum of Vue 2 support is currently required.
-
-## Using Dialtone Vue in your Project
-
-Project using Dialtone Vue should be aware of the requirements:
+Projects using Dialtone Vue should be aware of the requirements:
 
 - Dialtone classes must be made available globally (to avoid duplication, Dialtone Vue does not do this for you).
 - A tool like Webpack must be used to package the SFC components from Dialtone Vue.
@@ -106,3 +29,15 @@ Project using Dialtone Vue should be aware of the requirements:
 - Dialtone Vue components are built for Vue 2, with Vue 3 support coming soon.
 
 These requirements are enforced via peerdependencies of Dialtone Vue when possible.
+
+## Contributing
+
+If you would like to contribute to Dialtone Vue the first step is to get the project running locally. Follow the below quickstart to do so.
+
+1. Clone the repo `git clone https://github.com/dialpad/dialtone-vue.git`
+2. Install storybook dependencies `npm run storybook:install`
+3. Install dialtone-vue dependencies `npm install`
+4. Run local dev server `npm start`
+5. Visit local dev server at http://localhost:9011/
+
+Next read the more detailed contributor documentation in [CONTRIBUTING.md](.github/CONTRIBUTING.md).