pc5kflswa
/
docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add target attribute documentation for menu item (#191)

Browse Source 
添加主题开发 - 导航菜单中关于 `target` 属性的文档

/kind documentation

Fixes #190 

```release-note
None
```
JohnNiang-patch-1
Li 2 years ago committed by GitHub
parent 0998964dca
commit 1d939e714f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 97 additions and 17 deletions
Show Stats Download Patch File Download Diff File

18
docs/developer-guide/theme/finder-apis/menu.md
Unescape View File

@ -30,9 +30,14 @@ menuFinder.getByName(name)
<div th:with="menu = ${menuFinder.getByName('menu-foo')}"> <div th:with="menu = ${menuFinder.getByName('menu-foo')}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```
@ -60,9 +65,14 @@ menuFinder.getPrimary()
<div th:with="menu = ${menuFinder.getPrimary()}"> <div th:with="menu = ${menuFinder.getPrimary()}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```

12
docs/developer-guide/theme/vo/MenuItemVo.md
Unescape View File

@ -17,12 +17,13 @@
"children": [ // 下级菜单项，菜单项的 metadata.name 集合 "children": [ // 下级菜单项，菜单项的 metadata.name 集合
"string" "string"
], ],
"target": "#Target", // 菜单页面打开方式，枚举类型
"targetRef": { // 与其他资源比如文章的关联，一般无需直接使用 "targetRef": { // 与其他资源比如文章的关联，一般无需直接使用
"group": "string", "group": "string",
"version": "string", "version": "string",
"kind": "string", "kind": "string",
"name": "string" "name": "string"
} },
}, },
"status": { "status": {
"displayName": "string", // 显示名称 "displayName": "string", // 显示名称
@ -32,3 +33,12 @@
"parentName": "string", "parentName": "string",
} }
``` ```
```java title="Target"
enum Target {
BLANK("_blank"), // 在新窗口打开
SELF("_self"), // 在当前窗口打开
PARENT("_parent"), // 在父窗口打开
TOP("_top"); // 在顶级窗口打开
}
```

18
versioned_docs/version-2.1/developer-guide/theme/finder-apis/menu.md
Unescape View File

@ -30,9 +30,14 @@ menuFinder.getByName(name)
<div th:with="menu = ${menuFinder.getByName('menu-foo')}"> <div th:with="menu = ${menuFinder.getByName('menu-foo')}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```
@ -60,9 +65,14 @@ menuFinder.getPrimary()
<div th:with="menu = ${menuFinder.getPrimary()}"> <div th:with="menu = ${menuFinder.getPrimary()}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```

10
versioned_docs/version-2.1/developer-guide/theme/vo/MenuItemVo.md
Unescape View File

@ -17,6 +17,7 @@
"children": [ // 下级菜单项，菜单项的 metadata.name 集合 "children": [ // 下级菜单项，菜单项的 metadata.name 集合
"string" "string"
], ],
"target": "#Target", // 菜单页面打开方式，枚举类型
"targetRef": { // 与其他资源比如文章的关联，一般无需直接使用 "targetRef": { // 与其他资源比如文章的关联，一般无需直接使用
"group": "string", "group": "string",
"version": "string", "version": "string",
@ -32,3 +33,12 @@
"parentName": "string", "parentName": "string",
} }
``` ```
```java title="Target"
enum Target {
BLANK("_blank"), // 在新窗口打开
SELF("_self"), // 在当前窗口打开
PARENT("_parent"), // 在父窗口打开
TOP("_top"); // 在顶级窗口打开
}
```

18
versioned_docs/version-2.2/developer-guide/theme/finder-apis/menu.md
Unescape View File

@ -30,9 +30,14 @@ menuFinder.getByName(name)
<div th:with="menu = ${menuFinder.getByName('menu-foo')}"> <div th:with="menu = ${menuFinder.getByName('menu-foo')}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```
@ -60,9 +65,14 @@ menuFinder.getPrimary()
<div th:with="menu = ${menuFinder.getPrimary()}"> <div th:with="menu = ${menuFinder.getPrimary()}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```

10
versioned_docs/version-2.2/developer-guide/theme/vo/MenuItemVo.md
Unescape View File

@ -17,6 +17,7 @@
"children": [ // 下级菜单项，菜单项的 metadata.name 集合 "children": [ // 下级菜单项，菜单项的 metadata.name 集合
"string" "string"
], ],
"target": "#Target", // 菜单页面打开方式，枚举类型
"targetRef": { // 与其他资源比如文章的关联，一般无需直接使用 "targetRef": { // 与其他资源比如文章的关联，一般无需直接使用
"group": "string", "group": "string",
"version": "string", "version": "string",
@ -32,3 +33,12 @@
"parentName": "string", "parentName": "string",
} }
``` ```
```java title="Target"
enum Target {
BLANK("_blank"), // 在新窗口打开
SELF("_self"), // 在当前窗口打开
PARENT("_parent"), // 在父窗口打开
TOP("_top"); // 在顶级窗口打开
}
```

18
versioned_docs/version-2.3/developer-guide/theme/finder-apis/menu.md
Unescape View File

@ -30,9 +30,14 @@ menuFinder.getByName(name)
<div th:with="menu = ${menuFinder.getByName('menu-foo')}"> <div th:with="menu = ${menuFinder.getByName('menu-foo')}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```
@ -60,9 +65,14 @@ menuFinder.getPrimary()
<div th:with="menu = ${menuFinder.getPrimary()}"> <div th:with="menu = ${menuFinder.getPrimary()}">
<ul th:with="menuItems = ${menu.menuItems}"> <ul th:with="menuItems = ${menu.menuItems}">
<li th:each="menuItem : ${menuItems}"> <li th:each="menuItem : ${menuItems}">
<a th:href="@{${menuItem.status.href}}" th:text="${menuItem.spec.displayName}"></a> <a
th:href="@{${menuItem.status.href}}"
th:text="${menuItem.spec.displayName}"
th:target="${menuItem.spec.target?.value}"
>
</a>
</li> </li>
</ul> </ul>
</div> </div>
``` ```

10
versioned_docs/version-2.3/developer-guide/theme/vo/MenuItemVo.md
Unescape View File

@ -17,6 +17,7 @@
"children": [ // 下级菜单项，菜单项的 metadata.name 集合 "children": [ // 下级菜单项，菜单项的 metadata.name 集合
"string" "string"
], ],
"target": "#Target", // 菜单页面打开方式，枚举类型
"targetRef": { // 与其他资源比如文章的关联，一般无需直接使用 "targetRef": { // 与其他资源比如文章的关联，一般无需直接使用
"group": "string", "group": "string",
"version": "string", "version": "string",
@ -32,3 +33,12 @@
"parentName": "string", "parentName": "string",
} }
``` ```
```java title="Target"
enum Target {
BLANK("_blank"), // 在新窗口打开
SELF("_self"), // 在当前窗口打开
PARENT("_parent"), // 在父窗口打开
TOP("_top"); // 在顶级窗口打开
}
```

Write Preview
Loading…
Cancel
Save