blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs(@vant/use): add vuepress

Browse Source
This commit is contained in:
chenjiahan 2020-10-04 19:42:44 +08:00
parent 79493de49d
commit ca860fda5f
14 changed files with 7349 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/vant-cli/changelog.md
View File

@ -10,7 +10,7 @@
`2020-09-26`
- 新增 Open Sas 字体
- 新增 Open Sans 字体
- 修复搜索时无法跳转到对应锚点的问题
- 修复自定义 webpack 配置时某些情况下出现配置错误的问题

33
packages/vant-use/.vuepress/config.js Normal file
View File

@ -0,0 +1,33 @@
module.exports = {
base: '/vant-use/',
title: 'Vant Use',
dest: 'dist',
head: [['link', { rel: 'icon', href: 'https://img.yzcdn.cn/vant/logo.png' }]],
themeConfig: {
nav: [
{
text: 'Github',
link: 'https://github.com/youzan/vant/tree/next/packages/vant-use',
},
],
sidebarDepth: 0,
sidebar: [
{
title: 'State',
collapsable: false,
// children: ['/src/useToggle/'],
},
{
title: 'DOM',
collapsable: false,
children: [
'/src/useClickAway/',
'/src/useEventListener/',
'/src/usePageVisibility/',
'/src/useScrollParent/',
// '/src/useWindowSize/',
],
},
],
},
};

163
packages/vant-use/.vuepress/styles/font.styl Normal file
View File

@ -0,0 +1,163 @@
/* cyrillic-ext */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFWJ0bf8pkAp6a.woff2)
format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F,
U+FE2E-FE2F;
}
/* cyrillic */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFUZ0bf8pkAp6a.woff2)
format('woff2');
unicode-range: U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}
/* greek-ext */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFWZ0bf8pkAp6a.woff2)
format('woff2');
unicode-range: U+1F00-1FFF;
}
/* greek */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFVp0bf8pkAp6a.woff2)
format('woff2');
unicode-range: U+0370-03FF;
}
/* vietnamese */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFWp0bf8pkAp6a.woff2)
format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1,
U+01AF-01B0, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFW50bf8pkAp6a.woff2)
format('woff2');
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB,
U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-weight: 400;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans Regular'), local('OpenSans-Regular'),
url(https://b.yzcdn.cn/vant/mem8YaGs126MiZpBA-UFVZ0bf8pkAg.woff2)
format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
U+FEFF, U+FFFD;
}
/* cyrillic-ext */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOX-hpKKSTj5PW.woff2)
format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F,
U+FE2E-FE2F;
}
/* cyrillic */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOVuhpKKSTj5PW.woff2)
format('woff2');
unicode-range: U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}
/* greek-ext */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOXuhpKKSTj5PW.woff2)
format('woff2');
unicode-range: U+1F00-1FFF;
}
/* greek */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOUehpKKSTj5PW.woff2)
format('woff2');
unicode-range: U+0370-03FF;
}
/* vietnamese */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOXehpKKSTj5PW.woff2)
format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1,
U+01AF-01B0, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOXOhpKKSTj5PW.woff2)
format('woff2');
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB,
U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-weight: 600;
font-family: 'Open Sans';
font-style: normal;
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
url(https://b.yzcdn.cn/vant/mem5YaGs126MiZpBA-UNirkOUuhpKKSTjw.woff2)
format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
U+FEFF, U+FFFD;
}

25
packages/vant-use/.vuepress/styles/index.styl Normal file
View File

@ -0,0 +1,25 @@
@import './font.styl'
body {
font-family: 'Open Sans', -apple-system, BlinkMacSystemFont, 'Helvetica Neue',
Helvetica, Segoe UI, Arial, Roboto, 'PingFang SC', 'miui',
'Hiragino Sans GB', 'Microsoft Yahei', sans-serif;
-webkit-font-smoothing: antialiased;
}
.theme-default-content pre code {
font-size: 14px;
font-family: 'Source Code Pro', 'Monaco', 'Inconsolata', monospace;
line-height: 26px;
white-space: pre-wrap;
word-wrap: break-word;
-webkit-font-smoothing: auto;
}
em {
color: #4fc08d;
font-size: 14px;
font-family: 'Source Code Pro', 'Monaco', 'Inconsolata', monospace;
font-style: normal;
-webkit-font-smoothing: auto;
}

2
packages/vant-use/.vuepress/styles/palette.styl Normal file
View File

@ -0,0 +1,2 @@
$accentColor = #4fc08d;

1
packages/vant-use/README.md Normal file
View File

@ -0,0 +1 @@
# Vant Use

6
packages/vant-use/package.json
View File

@ -10,7 +10,9 @@
"dev": "tsc -m esNext --outDir es --watch",
"clean": "rm -rf ./es && rm -rf ./lib",
"build": "yarn clean && tsc && tsc -m esNext --outDir es",
"release": "yarn build && release-it"
"release": "yarn build && release-it",
"docs:dev": "vuepress dev",
"docs:build": "vuepress build"
},
"publishConfig": {
"access": "public",
@ -21,7 +23,7 @@
"devDependencies": {
"release-it": "^14.0.2",
"typescript": "^4.0.2",
"vue": "^3.0.0-rc.10"
"vuepress": "^1.6.0"
},
"release-it": {
"git": {

7
packages/vant-use/src/package.json Normal file
View File

@ -0,0 +1,7 @@
{
"private": true,
"license": "MIT",
"devDependencies": {
"vue": "^3.0.0"
}
}

10
packages/vant-use/src/useClickAway/README.zh-CN.md → packages/vant-use/src/useClickAway/README.md
View File

@ -70,11 +70,11 @@ type Options = {
## 参数
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| target | 绑定事件的元素 | \_Element | Ref<Element>\_ | - |
| listener | 点击外部时触发的回调函数 | _EventListener_ | - |
| options | 可选的配置项 | _Options_ | `{ eventName: 'click' }` |
| 参数 | 说明 | 类型 | 默认值 |
| -------- | ------------------------ | -------------------------- | ------ |
| target | 绑定事件的元素 | _Element \| Ref\<Element>_ | - |
| listener | 点击外部时触发的回调函数 | _EventListener_ | - |
| options | 可选的配置项 | _Options_ | 见下表 |
## Options

2
packages/vant-use/src/useEventListener/README.zh-CN.md → packages/vant-use/src/useEventListener/README.md
View File

@ -58,6 +58,6 @@ type Options = {
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| target | 绑定事件的元素 | \_EventTarget | Ref<EventTarget>\_ | `window` |
| target | 绑定事件的元素 | _EventTarget \| Ref\<EventTarget>_ | `window` |
| capture | 是否在事件捕获阶段触发 | _boolean_ | `false` |
| passive | 设置为 `true` 时，表示 `listener` 永远不会调用 `preventDefault` | _boolean_ | `false` |

2
packages/vant-use/src/usePageVisibility/README.zh-CN.md → packages/vant-use/src/usePageVisibility/README.md
View File

@ -33,4 +33,4 @@ type VisibilityState = 'visible' | 'hidden';
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| visibilityState | 页面当前的可见状态，`visible` 为可见，`hidden` 为隐藏 | _Ref<VisibilityState>_ | - |
| visibilityState | 页面当前的可见状态，`visible` 为可见，`hidden` 为隐藏 | _Ref\<VisibilityState>_ | - |

12
packages/vant-use/src/useScrollParent/README.zh-CN.md → packages/vant-use/src/useScrollParent/README.md
View File

@ -40,12 +40,12 @@ function useScrollParent(element: Ref<Element>): Ref<Element>;
## 参数
| 参数 | 说明 | 类型 | 默认值 |
| ------- | -------- | -------------- | ------ |
| element | 当前元素 | _Ref<Element>_ | - |
| 参数 | 说明 | 类型 | 默认值 |
| ------- | -------- | --------------- | ------ |
| element | 当前元素 | _Ref\<Element>_ | - |
## 返回值
| 参数 | 说明 | 类型 | 默认值 |
| ------------ | ------------------ | -------------- | ------ |
| scrollParent | 最近的可滚动父元素 | _Ref<Element>_ | - |
| 参数 | 说明 | 类型 | 默认值 |
| ------------ | ------------------ | --------------- | ------ |
| scrollParent | 最近的可滚动父元素 | _Ref\<Element>_ | - |

104
packages/vant-use/src/yarn.lock Normal file
View File

@ -0,0 +1,104 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1
"@babel/helper-validator-identifier@^7.10.4":
version "7.10.4"
resolved "https://registry.npm.taobao.org/@babel/helper-validator-identifier/download/@babel/helper-validator-identifier-7.10.4.tgz?cache=0&sync_timestamp=1593522720715&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2F%40babel%2Fhelper-validator-identifier%2Fdownload%2F%40babel%2Fhelper-validator-identifier-7.10.4.tgz#a78c7a7251e01f616512d31b10adcf52ada5e0d2"
integrity sha1-p4x6clHgH2FlEtMbEK3PUq2l4NI=
"@babel/parser@^7.11.5":
version "7.11.5"
resolved "https://registry.npm.taobao.org/@babel/parser/download/@babel/parser-7.11.5.tgz#c7ff6303df71080ec7a4f5b8c003c58f1cf51037"
integrity sha1-x/9jA99xCA7HpPW4wAPFjxz1EDc=
"@babel/types@^7.11.5":
version "7.11.5"
resolved "https://registry.npm.taobao.org/@babel/types/download/@babel/types-7.11.5.tgz#d9de577d01252d77c6800cee039ee64faf75662d"
integrity sha1-2d5XfQElLXfGgAzuA57mT691Zi0=
dependencies:
"@babel/helper-validator-identifier" "^7.10.4"
lodash "^4.17.19"
to-fast-properties "^2.0.0"
"@vue/compiler-core@3.0.0":
version "3.0.0"
resolved "https://registry.npm.taobao.org/@vue/compiler-core/download/@vue/compiler-core-3.0.0.tgz#25e4f079cf6c39f83bad23700f814c619105a0f2"
integrity sha1-JeTwec9sOfg7rSNwD4FMYZEFoPI=
dependencies:
"@babel/parser" "^7.11.5"
"@babel/types" "^7.11.5"
"@vue/shared" "3.0.0"
estree-walker "^2.0.1"
source-map "^0.6.1"
"@vue/compiler-dom@3.0.0":
version "3.0.0"
resolved "https://registry.npm.taobao.org/@vue/compiler-dom/download/@vue/compiler-dom-3.0.0.tgz#4cbb48fcf1f852daef2babcf9953b681ac463526"
integrity sha1-TLtI/PH4UtrvK6vPmVO2gaxGNSY=
dependencies:
"@vue/compiler-core" "3.0.0"
"@vue/shared" "3.0.0"
"@vue/reactivity@3.0.0":
version "3.0.0"
resolved "https://registry.npm.taobao.org/@vue/reactivity/download/@vue/reactivity-3.0.0.tgz#fd15632a608650ce2a969c721787e27e2c80aa6b"
integrity sha1-/RVjKmCGUM4qlpxyF4fifiyAqms=
dependencies:
"@vue/shared" "3.0.0"
"@vue/runtime-core@3.0.0":
version "3.0.0"
resolved "https://registry.npm.taobao.org/@vue/runtime-core/download/@vue/runtime-core-3.0.0.tgz#480febf1bfe32798b6abbd71a88f8e8b473a51c2"
integrity sha1-SA/r8b/jJ5i2q71xqI+Oi0c6UcI=
dependencies:
"@vue/reactivity" "3.0.0"
"@vue/shared" "3.0.0"
"@vue/runtime-dom@3.0.0":
version "3.0.0"
resolved "https://registry.npm.taobao.org/@vue/runtime-dom/download/@vue/runtime-dom-3.0.0.tgz#e0d1f7c7e22e1318696014cc3501e06b288c2e11"
integrity sha1-4NH3x+IuExhpYBTMNQHgayiMLhE=
dependencies:
"@vue/runtime-core" "3.0.0"
"@vue/shared" "3.0.0"
csstype "^2.6.8"
"@vue/shared@3.0.0":
version "3.0.0"
resolved "https://registry.npm.taobao.org/@vue/shared/download/@vue/shared-3.0.0.tgz#ec089236629ecc0f10346b92f101ff4339169f1a"
integrity sha1-7AiSNmKezA8QNGuS8QH/QzkWnxo=
csstype@^2.6.8:
version "2.6.13"
resolved "https://registry.npm.taobao.org/csstype/download/csstype-2.6.13.tgz?cache=0&sync_timestamp=1598348290847&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fcsstype%2Fdownload%2Fcsstype-2.6.13.tgz#a6893015b90e84dd6e85d0e3b442a1e84f2dbe0f"
integrity sha1-pokwFbkOhN1uhdDjtEKh6E8tvg8=
estree-walker@^2.0.1:
version "2.0.1"
resolved "https://registry.npm.taobao.org/estree-walker/download/estree-walker-2.0.1.tgz#f8e030fb21cefa183b44b7ad516b747434e7a3e0"
integrity sha1-+OAw+yHO+hg7RLetUWt0dDTno+A=
lodash@^4.17.19:
version "4.17.20"
resolved "https://registry.npm.taobao.org/lodash/download/lodash-4.17.20.tgz?cache=0&sync_timestamp=1597336147792&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Flodash%2Fdownload%2Flodash-4.17.20.tgz#b44a9b6297bcb698f1c51a3545a2b3b368d59c52"
integrity sha1-tEqbYpe8tpjxxRo1RaKzs2jVnFI=
source-map@^0.6.1:
version "0.6.1"
resolved "https://registry.npm.taobao.org/source-map/download/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
integrity sha1-dHIq8y6WFOnCh6jQu95IteLxomM=
to-fast-properties@^2.0.0:
version "2.0.0"
resolved "https://registry.npm.taobao.org/to-fast-properties/download/to-fast-properties-2.0.0.tgz#dc5e698cbd079265bc73e0377681a4e4e83f616e"
integrity sha1-3F5pjL0HkmW8c+A3doGk5Og/YW4=
vue@^3.0.0:
version "3.0.0"
resolved "https://registry.npm.taobao.org/vue/download/vue-3.0.0.tgz#cfb5df5c34efce319b113a1667d12b74dcfd9c90"
integrity sha1-z7XfXDTvzjGbEToWZ9ErdNz9nJA=
dependencies:
"@vue/compiler-dom" "3.0.0"
"@vue/runtime-dom" "3.0.0"
"@vue/shared" "3.0.0"

7092
packages/vant-use/yarn.lock
View File

File diff suppressed because it is too large Load Diff