Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

更新中:样式文档 #1758

Merged
merged 93 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
93 commits
Select commit Hold shift + click to select a range
56c388b
doc: 添加一期基础组件文档
Dec 11, 2024
1e456dc
doc: 添加一期基础组件文档
Dec 11, 2024
faff052
add swiper doc
Dec 12, 2024
8ef011a
样式文档
wenwenhua Dec 16, 2024
3cbbfe0
样式文档
wenwenhua Dec 16, 2024
3a0e80d
提交切分支
Dec 16, 2024
2b467a7
feat: add init style md
wenwenhua Dec 16, 2024
78b9d52
Merge branch 'master' into feat-rn-components-doc
Dec 17, 2024
951f3b5
Merge branch 'feat-rn-components-doc' of https://github.com/didi/mpx …
Dec 17, 2024
ecf1ae1
docs: 修改文档
Dec 17, 2024
6646b41
docs: 修改文档
Dec 17, 2024
10738be
docs: 修改文档
Dec 18, 2024
54b6df6
docs: 修改文档
Dec 18, 2024
7760165
docs: 修改文档
Dec 18, 2024
1cb192f
docs: 修改文档
Dec 18, 2024
1281b30
docs: 添加事件相关
Dec 18, 2024
de2110a
docs:修改文档
Dec 18, 2024
22db764
Merge branch 'master' into feat-rn-components-doc
Dec 19, 2024
bc858f0
docs: 添加文档结构
Blackgan3 Dec 19, 2024
e4148e0
docs: 添加事件相关
Dec 20, 2024
327aa11
先提交一版
Dec 23, 2024
3f6a4a5
编写完后先提交一版
Dec 24, 2024
d60f535
Merge remote-tracking branch 'refs/remotes/origin/feat-rn-components-…
Blackgan3 Dec 26, 2024
1dd453c
docs:暂存模版语法改动部分文档
Blackgan3 Dec 26, 2024
918a54e
docs: save docs change
Blackgan3 Dec 26, 2024
530a217
doc: 修改文档
Dec 26, 2024
1c39160
docs: update picker-view
wangshunnn Dec 26, 2024
e6dd413
docs: update picker-view
wangshunnn Dec 26, 2024
5a3b106
feat: 补充模版指令
Blackgan3 Dec 27, 2024
c1584b3
feat: 回滚代码
Blackgan3 Dec 27, 2024
6c946af
docs: 暂存文档改动
Blackgan3 Dec 27, 2024
a88fbd2
feat: update image doc
WX-DongXing Dec 27, 2024
5998d1d
feat: doc add scale of swiper
Dec 30, 2024
5d721b3
调整写法
Dec 31, 2024
5468ae9
update: 文档
Dec 31, 2024
f006c16
add style md
wenwenhua Dec 31, 2024
af99b93
补充api支持能力
Dec 31, 2024
321a321
add style md
wenwenhua Dec 31, 2024
aec1a8a
Merge branch 'feat-style-md' of github.com:didi/mpx into feat-style-md
wenwenhua Dec 31, 2024
fc18848
add style md
wenwenhua Dec 31, 2024
27a0eff
feat: 暂时存储组件定义文档
Blackgan3 Jan 2, 2025
00b5f24
doc(*): add switch、rich-text doc.
Jan 2, 2025
74f87ff
Merge branch 'feat-rn-components-doc' of https://github.com/didi/mpx …
Jan 2, 2025
b22fc88
[update]add wx:ref
CommanderXL Jan 2, 2025
132df03
Merge branch 'master' of github.com:didi/mpx into feat-style-md
Jan 2, 2025
ca1fab6
fix: update docs
Jan 2, 2025
c423761
文档补充
wenwenhua Jan 2, 2025
8193383
Merge branch 'feat-style-md' of github.com:didi/mpx into feat-style-md
wenwenhua Jan 2, 2025
722f72c
doc: 补充事件注意事项
Jan 3, 2025
f32825f
Merge branch 'feat-rn-components-doc' of https://github.com/didi/mpx …
Jan 3, 2025
c661482
Merge remote-tracking branch 'origin/docs-rn-template' into docs-rn-t…
Blackgan3 Jan 3, 2025
60ff439
feat: 修改文档描述
Blackgan3 Jan 3, 2025
3b33e45
[update]add createSelectorQuery
CommanderXL Jan 3, 2025
8142ebd
Merge branch 'feat-rn-components-doc' of github.com:didi/mpx into fea…
CommanderXL Jan 3, 2025
534f087
[update]add selectorQuery.select
CommanderXL Jan 3, 2025
891e514
[update]select/selectAll
CommanderXL Jan 3, 2025
ec8389a
文档补充
wenwenhua Jan 3, 2025
4491185
去掉无用修改
Jan 6, 2025
5cfa197
Merge branch 'feat-rn-components-doc' of https://github.com/didi/mpx …
Jan 6, 2025
4d436df
去掉无用修改
Jan 6, 2025
c676857
文档补充
wenwenhua Jan 6, 2025
bb6eac4
docs: 保存文档修改
Blackgan3 Jan 6, 2025
e6f308f
文档补充
wenwenhua Jan 6, 2025
28c601d
fix(*): fix lint.
Jan 6, 2025
00a4839
Merge branch 'feat-rn-components-doc' of https://github.com/didi/mpx …
Jan 6, 2025
4834589
文档补充
wenwenhua Jan 6, 2025
c0d286e
文档补充
wenwenhua Jan 6, 2025
7eab4f1
merge: docs merge
Jan 6, 2025
aca51ad
feat: 修改组件定义章节
Blackgan3 Jan 7, 2025
41ff948
docs: update picker-view props
wangshunnn Jan 7, 2025
317c8d7
doc: 修改文档
Jan 7, 2025
7c6db12
Merge branch 'feat-rn-components-doc' of https://github.com/didi/mpx …
Jan 7, 2025
ff30179
docs: 添加relations表述
Blackgan3 Jan 8, 2025
d8b4750
doc(background-image): add image.
Jan 8, 2025
29911f5
doc(*): add image.
Jan 8, 2025
1a73879
docs: 修改自定义组件文档
Blackgan3 Jan 8, 2025
96322f6
docs: 暂时存储
Blackgan3 Jan 9, 2025
993a831
feat: save change
Blackgan3 Jan 9, 2025
1ba1631
docs: 暂时更新到组件 setData API
Blackgan3 Jan 9, 2025
086bd91
文档补充
wenwenhua Jan 9, 2025
4cfbade
docs: update picker-view
wangshunnn Jan 9, 2025
1c36b79
feat: document supplement
WX-DongXing Jan 9, 2025
5a80259
文档补充
wenwenhua Jan 10, 2025
eef631e
fix: 修复文档报错
Blackgan3 Jan 10, 2025
a7453b8
Merge branch 'refs/heads/feat-rn-components-doc' into feat-style-md
Blackgan3 Jan 10, 2025
86498a3
Merge branch 'refs/heads/docs-rn-template' into feat-style-md
Blackgan3 Jan 10, 2025
31afc66
fix: update docs
Jan 10, 2025
591d701
Merge remote-tracking branch 'origin/feat-style-md' into feat-style-md
Blackgan3 Jan 10, 2025
bbca378
docs: 添加跨端文档
Blackgan3 Jan 10, 2025
1ce5c01
docs: 添加跨端文档
Blackgan3 Jan 10, 2025
42c8194
Merge branch 'refs/heads/master' into feat-style-md
Blackgan3 Jan 10, 2025
514ddb3
docs: 回退部分改动
Blackgan3 Jan 10, 2025
3e96f3f
Merge branch 'master' into feat-style-md
hiyuki Jan 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs-vuepress/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,16 @@ const sidebar = {
'advance/provide-inject'
]
},
{
title: '跨端',
collapsable: false,
children: [
'platform/basic',
// 'platform/miniprogram',
// 'platform/web',
'platform/rn'
]
},
{
title: '组合式 API',
collapsable: false,
Expand Down
56 changes: 45 additions & 11 deletions docs-vuepress/api/directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ Page({
```

``` js
Page({
import { createComponent } from '@mpxjs/core'
createComponent({
data: {
array: [{
id: 1, text: 'foo'
Expand Down Expand Up @@ -126,7 +127,8 @@ Page({
```

``` js
Page({
import { createComponent } from '@mpxjs/core'
createComponent({
data: {
array: [{
id: 1, text: 'foo'
Expand Down Expand Up @@ -549,7 +551,8 @@ Mpx提供了 `wx:ref=xxx` 来更方便获取 WXML 节点信息的对象。在JS
```

```js
Page({
import {createPage} from '@mpxjs/core'
createPage({
data: {
show: false
}
Expand Down Expand Up @@ -679,22 +682,28 @@ capture-catch中断捕获阶段和取消冒泡阶段

## @mode

`type mode = 'wx' | 'ali' | 'qq' | 'swan' | 'tt' | 'web' | 'qa'`
`type mode = 'wx' | 'ali' | 'qq' | 'swan' | 'tt' | 'web' | 'qa' | 'ios' | 'android' | 'harmony'`

### 属性中使用
跨平台输出场景下,Mpx 框架允许用户在组件上使用 @ 和 | 符号来指定某个节点或属性只在某些平台下有效。

```html
<button
open-type@wx|swan="getUserInfo"
bindgetuserinfo@wx|swan="getUserInfo"
open-type@ali="getAuthorize"
open-type@wx|swan|ios="getUserInfo"
bindgetuserinfo@wx|swan|ios="getUserInfo"
open-type@ali|ios="getAuthorize"
scope@ali="userInfo"
enable-background@ios|android="{{ true }}"
onTap@ali="onTap">
获取用户信息
</button>
```
在上方示例中,开发者可以便捷的设置在支付宝小程序与微信和百度小程序等平台分别生效的 open-type 属性,
以及事件绑定或其他属性。假设当前 srcMode 为 wx,目标平台为 ali,则输出产物为:
例如在上述示例中:
* 在支付宝小程序与微信和百度小程序等平台分别生效的 open-type 等属性
* 在输出iOS或android平台时,enable-background 属性生效
* 以及事件绑定或其他属性灵活的进行条件编译

假设当前 srcMode 为 wx,目标平台为 ali,则输出产物为:
```html
<button
open-type="getAuthorize"
Expand All @@ -703,7 +712,23 @@ capture-catch中断捕获阶段和取消冒泡阶段
获取用户信息
</button>
```
同时,该指令也可以作用在单个节点上,但需要注意的是,该指令作用在单个节点时,节点仅在目标平台输出,同时节点自身属性不会进行跨平台语法转换,不过其子节点不受影响。
假设当前 srcMode 为 wx,目标平台为 ios,则输出产物为:
```html
<button
open-type="getAuthorize"
bindgetuserinfo="getUserInfo"
open-type="getAuthorize"
enable-background="{{ true }}"
>
获取用户信息
</button>
```

### 节点中使用
同时,该指令也可以作用在单个节点上,来对节点进行跨平台条件判断。

但需要注意的是,该指令作用在单个节点时,节点仅在目标平台输出,同时节点自身属性不会进行跨平台语法转换,不过其子节点不受影响。

```html
<!--当srcMode为wx,跨平台输出ali时-->
<!--错误写法-->
Expand All @@ -715,10 +740,17 @@ capture-catch中断捕获阶段和取消冒泡阶段
<view wx:if="{{flag}}">text</view>
</view>
```
::: danger
另外在跨端输出 React Native 和 H5 时,不要在基础组件节点上使用 @mode 指令,仅可在自定义组件节点使用 @mode 指令
:::
```html
<!--错误写法-->
<view @ios>测试数据</view>
```

## @_mode

`type _mode = '_wx' | '_ali' | '_qq' | '_swan' | '_tt' | '_web' | '_qa'`
`type _mode = '_wx' | '_ali' | '_qq' | '_swan' | '_tt' | '_web' | '_qa' | '_ios' | '_android' | '_harmony'`

有时开发者期望使用 @mode 这种方式仅控制节点的展示,保留节点属性的平台转换能力,为此 Mpx 实现了一个隐式属性条件编译能力。
```html
Expand All @@ -727,6 +759,8 @@ capture-catch中断捕获阶段和取消冒泡阶段
```
在对应的平台前加一个_,例如@_ali、@_swan、@_tt等,使用该隐式规则仅有条件编译能力,节点属性语法转换能力依旧。

在跨端输出 React Native 和 H5 时,可以在节点上使用该属性。

## @env

`string`
Expand Down
Loading
Loading