Skip to content

Commit

Permalink
docs: update docs for "Blocklet Component"
Browse files Browse the repository at this point in the history
  • Loading branch information
linchen1987 committed Jul 20, 2023
1 parent fd393b2 commit b3d35eb
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.1.135 (July 20, 2023)

- docs: update docs for "Blocklet Component"

## 0.1.134 (July 11, 2023)

- docs: update docs for blocklet sdk
Expand Down
2 changes: 1 addition & 1 deletion developer/docs/blocklet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ repository:
type: git
url: git+https://github.com/blocklet/blocklet-site.git
specVersion: 1.2.8
version: 0.1.134
version: 0.1.135
logo: logo.png
files:
- hooks/post-start.js
Expand Down
6 changes: 6 additions & 0 deletions developer/docs/pages/how-to/component/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ BLOCKLET_DEV_MOUNT_POINT=/xxx

> `blocklet-app-did` can be viewed in the blocklet details page
### Automatically set access control for component

When `whoCanAccess` in blocklet.yml is set to non-public access, access to this component will be blocked by the login page by default.

When developing, you can automatically set the component to public access by setting `blocklet.settings.whoCanAccess="all"` in `.env` to improve development efficiency.

## Component Mount Point

When a blocklet is composed, the blocklet will be mounted under the child path configured in the parent component.
Expand Down
6 changes: 6 additions & 0 deletions developer/docs/pages/how-to/component/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ BLOCKLET_DEV_MOUNT_POINT=/xxx

> `blocklet-app-did` 可在 blocklet 详情页中查看
### 自动设置组件的访问控制

当 blocklet.yml 中的 `whoCanAccess` 设置为非公开访问时,访问该组件默认会被登录页面拦截。

在开发时,你可以通过在 `.env` 中设置 `blocklet.settings.whoCanAccess="all"` 将该组件自动设置为公开访问,以提高开发效率。

## 组件挂载点

当一个 blocklet 被组合时,这个 blocklet 会被挂载到在父组件中配置的子路径下。
Expand Down
2 changes: 1 addition & 1 deletion developer/pages/blocklet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ repository:
type: git
url: git+https://github.com/blocklet/blocklet-site.git
specVersion: 1.2.8
version: 0.1.134
version: 0.1.135
logo: logo.png
files: []
interfaces:
Expand Down
2 changes: 1 addition & 1 deletion version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.134
0.1.135
2 changes: 1 addition & 1 deletion website/docs/blocklet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ repository:
type: git
url: git+https://github.com/blocklet/blocklet-site.git
specVersion: 1.2.8
version: 0.1.134
version: 0.1.135
logo: logo.png
files: []
interfaces:
Expand Down
2 changes: 1 addition & 1 deletion website/pages/blocklet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ repository:
type: git
url: git+https://github.com/blocklet/blocklet-site.git
specVersion: 1.2.8
version: 0.1.134
version: 0.1.135
logo: logo.png
files: []
interfaces:
Expand Down

0 comments on commit b3d35eb

Please sign in to comment.