@mantine-vue/mantine-header 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# @mantine-vue/mantine-header
|
|
2
|
+
|
|
3
|
+
Components used in the headers of `*.mantine.dev`-style documentation sites, Vue port of `@mantinex/mantine-header`.
|
|
4
|
+
|
|
5
|
+
> Mantine Vue is an independent community port of [Mantine](https://mantine.dev/) for Vue 3. It is not affiliated with or endorsed by the Mantine team.
|
|
6
|
+
|
|
7
|
+
This package powers the header/navigation of [mantine-vue.dev](https://mantine-vue.dev) itself. It's published for anyone building a similar documentation site on top of Mantine Vue, but it isn't a general-purpose UI package.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
yarn add @mantine-vue/mantine-header @mantine-vue/core @phosphor-icons/vue
|
|
13
|
+
|
|
14
|
+
# or with npm
|
|
15
|
+
npm i @mantine-vue/mantine-header @mantine-vue/core @phosphor-icons/vue
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```vue
|
|
21
|
+
<script setup>
|
|
22
|
+
import { HeaderControls, ColorSchemeControl, GithubControl } from '@mantine-vue/mantine-header'
|
|
23
|
+
</script>
|
|
24
|
+
|
|
25
|
+
<template>
|
|
26
|
+
<HeaderControls>
|
|
27
|
+
<ColorSchemeControl />
|
|
28
|
+
<GithubControl href="https://github.com/mantine-vue/mantine-vue" />
|
|
29
|
+
</HeaderControls>
|
|
30
|
+
</template>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Peer dependencies
|
|
34
|
+
|
|
35
|
+
- `vue` ^3.5.0
|
|
36
|
+
- `@mantine-vue/core`
|
|
37
|
+
- `@phosphor-icons/vue` ^2.2
|
|
38
|
+
|
|
39
|
+
## License
|
|
40
|
+
|
|
41
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mantine-vue/mantine-header",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"description": "Components used in headers of *.mantine.dev websites (Vue port of @mantinex/mantine-header)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"files": [
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"vue": "^3.5.0"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
|
-
"@mantine-vue/core": "1.1.
|
|
38
|
+
"@mantine-vue/core": "1.1.3",
|
|
39
39
|
"@phosphor-icons/vue": "^2.2",
|
|
40
40
|
"vue": "^3.5.0"
|
|
41
41
|
}
|