Skip to content

Commit

Permalink
[esm-transpiled-dist] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GianlucaGuarini committed Apr 23, 2019
1 parent 41ed4a4 commit 3fbbce2
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ npm install -S @dreipol/vue-ui
Pick any of the modules by importing them in your project, for example:

```js
import { UiInput } from '@dreipol/vue-ui/src/components'
import { UiInput } from '@dreipol/vue-ui'

export default {
components: { UiInput },
Expand Down
2 changes: 1 addition & 1 deletion src/components/accordion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Accordion component that could be used in a SPA or even as simple enhancement fo

## Usage
```js
import { UiAccordion } from '@dreipol/vue-ui/src/components';
import { UiAccordion } from '@dreipol/vue-ui';
```

## Props
Expand Down
14 changes: 7 additions & 7 deletions src/components/form/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Let's assume for example that you want to use the checkbox component in your vue
</template>
<script>
import { UiCheckbox } from '@dreipol/vue-ui/src/components';
import { UiCheckbox } from '@dreipol/vue-ui';
export default {
components: {
UiCheckbox,
Expand All @@ -22,7 +22,7 @@ Let's assume for example that you want to use the checkbox component in your vue
In case you want to use these components globally, without always importing them in any of your forms, you will need to register them via Vue:

```js
import { UiInput } from '@dreipol/vue-ui/src/components';
import { UiInput } from '@dreipol/vue-ui';
import Vue from 'vue';

// This component will now be globally available
Expand Down Expand Up @@ -204,7 +204,7 @@ The optional `ui-optgroup` component may be used to render native option groups.
</template>
<script>
import { UiSelect, UiOption, UiOptgroup } from '@dreipol/vue-ui/src/components';
import { UiSelect, UiOption, UiOptgroup } from '@dreipol/vue-ui';
export default {
components: {
UiSelect,
Expand Down Expand Up @@ -249,12 +249,12 @@ The select checkmark icon can be defined not only via `actions` slot but also vi
</ui-select>
```

You can also override the default select icon once and for all via `@dreipol/vue-ui/src/settings`:
You can also override the default select icon once and for all via `@dreipol/vue-ui`:

```js
import settings, { SELECT_ICON } from '@dreipol/vue-ui/src/settings';
import VueUI from '@dreipol/vue-ui';

settings.set(SELECT_ICON, {
VueUI.settings.set(VueUI.SELECT_ICON, {
symbol: 'arrow-down',
size: 'medium'
});
Expand All @@ -280,7 +280,7 @@ In a nutshell: The input fields are responsible for user events and rendering wh
</template>
<script>
import { UiInput, UiModelProvider } from '@dreipol/vue-ui/src/components';
import { UiInput, UiModelProvider } from '@dreipol/vue-ui';
export default {
components: {
UiInput,
Expand Down
2 changes: 1 addition & 1 deletion src/components/intersection-observer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ A simple implementation of the [`intersectionObserverMixin`](/src/mixins/interse

## Usage
```js
import { UiIntersectionObserver } from '@dreipol/vue-ui/src/components';
import { UiIntersectionObserver } from '@dreipol/vue-ui';
```

## Props
Expand Down
6 changes: 3 additions & 3 deletions src/components/overlay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can also choose to add multiple instances of this component in different loc
```vue
<script>
import { mapState } from 'vuex';
import { UiOverlay } from '@dreipol/vue-ui/src/components';
import { UiOverlay } from '@dreipol/vue-ui';
export default {
components: {
Expand All @@ -32,13 +32,13 @@ You can also choose to add multiple instances of this component in different loc

```js
import Vuex from 'vuex';
import overlay from '@dreipol/vue-ui/src/vuex/modules/overlay';
import { uiOverlayVuexModule } from '@dreipol/vue-ui';

const store = new Vuex.Store({
modules: {
'vue-ui': {
namespaced: true,
modules: { overlay },
modules: { overlay: uiOverlayVuexModule },
},
},
});
Expand Down
2 changes: 1 addition & 1 deletion src/mixins/intersection-observer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# intersectionObserverMixin
[IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver)
Load via `import { interactionObserverMixin } from '@dreipol/vue-ui/src/components';` and add it to the `mixins`.
Load via `import { interactionObserverMixin } from '@dreipol/vue-ui';` and add it to the `mixins`.

Now you can start observing an element:

Expand Down
2 changes: 1 addition & 1 deletion src/vuex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These vuex modules provide functionality for some components and are necessary f
These modules can be added to your project store. They are scoped within the `vue-ui` namespace.

```js
import { uiScrollVuexModule } from '@dreipol/vue-ui/src/vuex';
import { uiScrollVuexModule } from '@dreipol/vue-ui';

const store = new Vuex.Store({
modules: {
Expand Down

0 comments on commit 3fbbce2

Please sign in to comment.