Skip to content

Commit

Permalink
correct docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@oleksiikhr
oleksiikhr committed Oct 2, 2022
1 parent 854ba8b commit bff8c46
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 16 deletions.
58 changes: 58 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,64 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [3.0.0-beta.1](https://github.com/oleksiikhr/vue-stripe-menu/compare/v2.1.1...3.0.0-beta.1) (2021-08-08)

- Replacing the style calculation for background (https://github.com/oleksiikhr/vue-stripe-menu/issues/246).

**before**

```scss
.vsm-background {
transform: translate(152px, 0px) scaleX(1.08421) scaleY(1.2125);
}
```

**after**

```scss
.vsm-background {
transform: translate(246px, 10px);
width: 409px;
height: 485px;
}
```

- Build files

**before**

```
dist/demo.html
dist/vue-stripe-menu.common.js
dist/vue-stripe-menu.common.js.map
dist/vue-stripe-menu.css
dist/vue-stripe-menu.umd.js
dist/vue-stripe-menu.umd.js.map
dist/vue-stripe-menu.umd.min.js
dist/vue-stripe-menu.umd.min.js.map
```

**after**

```
dist/vue-stripe-menu.css
dist/vue-stripe-menu.es.js
dist/vue-stripe-menu.umd.js
```

---

- [TypeScript](https://www.typescriptlang.org/) added.
- Improved [ESLint](https://eslint.org/) configs, added [Prettier](https://prettier.io/) and [Stylelint](https://stylelint.io/).
- Added Github documents: code of conduct, contributors and issue templates.
- Installed [Node.js](https://nodejs.org/) as core `16.15.0`.
- Replaced [yarn](https://yarnpkg.com/) with [pnpm](https://pnpm.io/).
- Replaced [CircleCI](https://circleci.com/) with [Github Actions](https://github.com/features/actions).
- Removed build documentation files from the repository. The current build is in the [gh-pages](https://github.com/oleksiikhr/vue-stripe-menu/tree/gh-pages) branch.
- Added more workflows:
- Additional code check using [CodeQL](https://codeql.github.com/).
- Automatic publishing to [npm](https://www.npmjs.com/) from main branch.

### [2.1.1](https://github.com/oleksiikhr/vue-stripe-menu/compare/v2.1.0...v2.1.1) (2021-08-08)

* Migrate from deprecated libSass (node-sass library) to Dart Sass ([944ad5d3](https://github.com/oleksiikhr/vue-stripe-menu/commit/944ad5d33fbd648a5c3a5b5a5833e283b3bdd0f1))
Expand Down
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
Install the library in your project:

```shell
$ npm i vue-stripe-menu
$ npm i -D vue-stripe-menu

// $ yarn add vue-stripe-menu
// $ pnpm i vue-stripe-menu
// $ yarn add -D vue-stripe-menu
// $ pnpm add -D vue-stripe-menu
```

Import components:
Expand Down Expand Up @@ -255,13 +255,13 @@ export default {

| Property | Parameters | Description | Type | Default | Required |
|--------------------|---------------------|-----------------------------------------------------|----------------|---------|----------|
| menu | MenuObject | Description of the menu items | Array | | true |
| element | | HTMLElement for the root element | String | header | false |
| screen-offset | | Offset from the window screen | String, Number | header | false |
| dropdown-offset | | Offset from the dropdown menu | String, Number | header | false |
| transition-timeout | | Animation speed in ms (equals $vsm-transition scss) | String, Number | 250 | false |
| handler | hover, click | On what event to open dropdown menu | String | hover | false |
| align | center, left, right | Offset the position of the dropdown menu | String | center | false |
| menu | MenuObject | Description of the menu items | array | | true |
| element | | HTMLElement for the root element | string | header | false |
| screen-offset | | Offset from the window screen | string, number | header | false |
| dropdown-offset | | Offset from the dropdown menu | string, number | header | false |
| transition-timeout | | Animation speed in ms (equals $vsm-transition scss) | string, number | 250 | false |
| handler | hover, click | On what event to open dropdown menu | string | hover | false |
| align | center, left, right | Offset the position of the dropdown menu | string | center | false |

### [Menu] Events

Expand Down Expand Up @@ -304,18 +304,18 @@ export default {

| Property | Type | Description |
|------------|--------|---------------------------------------------------------------------------------------------------------|
| title | String | Menu item name. Can also be redefined through the slot |
| dropdown | String | Unique value indicates that this item has a dropdown menu |
| title | string | Menu item name. Can also be redefined through the slot |
| dropdown | string | Unique value indicates that this item has a dropdown menu |
| align | string | Offset the position of the dropdown menu (center/left/right) |
| element | String | HTMLElement or global component in the header element, if not specified, it will be <button /> or <a /> |
| attributes | Object | All attributes to be assigned in the header element (v-bind) |
| listeners | Object | All events to be assigned in the header element (v-on) |
| element | string | HTMLElement or global component in the header element, if not specified, it will be <button /> or <a /> |
| attributes | object | All attributes to be assigned in the header element (v-bind) |
| listeners | object | All events to be assigned in the header element (v-on) |

### [Mob] Props

| Property | Parameters | Description | Type | Default | Required |
|----------|------------|--------------------------------------|---------|---------|----------|
| v-model | | The state of the open/close the menu | Boolean | false | false |
| v-model | | The state of the open/close the menu | boolean | false | false |

### [Mob] Slots

Expand Down

0 comments on commit bff8c46

Please sign in to comment.