Skip to content

Commit 23ac66c

Browse files
authored
Merge pull request #402 from seratch/shortcuts-docs
Add shortcuts docs
2 parents 6515bb6 + df508f8 commit 23ac66c

File tree

8 files changed

+237
-175
lines changed

8 files changed

+237
-175
lines changed

docs/_includes/sidebar-ja.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@
2424
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/getting-started-with-bolt">Bolt️ ことはじめ</a></li>
2525
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/bolt-basics">Bolt️ の概要</a></li>
2626
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/slash-commands">スラッシュコマンド</a></li>
27-
<!--
28-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/actions">アクション</a></li>
29-
-->
3027
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/interactive-components">インタラクティブコンポーネント</a></li>
3128
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/modals">モーダル</a></li>
29+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/shortcuts">ショートカット</a></li>
3230
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/app-home">Home タブ</a></li>
3331
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/events-api">イベント API</a></li>
3432
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/app-distribution">アプリの配布 (OAuth)</a></li>

docs/_includes/sidebar.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@
2424
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt">Getting Started</a></li>
2525
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/bolt-basics">Bolt Basics</a></li>
2626
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/slash-commands">Slash Commands</a></li>
27-
<!--
28-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/actions">Actions</a></li>
29-
-->
3027
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/interactive-components">Interactive Components</a></li>
3128
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/modals">Modals</a></li>
29+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/shortcuts">Shortcuts</a></li>
3230
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/app-home">App Home</a></li>
3331
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/events-api">Events API</a></li>
3432
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/app-distribution">App Distribution (OAuth)</a></li>
-65.3 KB
Binary file not shown.

docs/guides/bolt-basics.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,25 @@ Here is the list of the available methods to dispatch events.
3434
|**app.event**|event type: **Class\<Event\>**|[**Events API**]({{ site.url | append: site.baseurl }}/guides/events-api): Responds to any kinds of bot/user events you subscribe.|
3535
|**app.message**|keyword: **String** \| **Pattern**|[**Events API**]({{ site.url | append: site.baseurl }}/guides/events-api): Responds to messages posted by a user only when the text in messages matches the given keyword or regular expressions.|
3636
|**app.command**|command name: **String** \| **Pattern**|[**Slash Commands**]({{ site.url | append: site.baseurl }}/guides/slash-commands): Responds to slash command invocations in the workspace.|
37-
|**app.messageAction**|callback_id: **String** \| **Pattern**|[**Actions**]({{ site.url | append: site.baseurl }}/guides/actions): Responds to user actions in message menus.|
3837
|**app.blockAction**|action_id: **String** \| **Pattern**|[**Interactive Components**]({{ site.url | append: site.baseurl }}/guides/interactive-components): Responds to user actions (e.g., click a button, choose an item from select menus, radio buttons, etc.) in **blocks**. These events can be triggered in all the surfaces (messages, modals, and Home tabs).|
3938
|**app.blockSuggestion**|action_id: **String** \| **Pattern**|[**Interactive Components**]({{ site.url | append: site.baseurl }}/guides/interactive-components): Responds to user actions to input a keyword (the length needs to be the `min_query_length` or longer) in select menus (external data source).|
4039
|**app.viewSubmission**|callback_id: **String** \| **Pattern**|[**Modals**]({{ site.url | append: site.baseurl }}/guides/modals): Responds to data submissions in modals.|
4140
|**app.viewClosed**|callback_id: **String** \| **Pattern**|[**Modals**]({{ site.url | append: site.baseurl }}/guides/modals): Responds to the events where users close modals by clicking Cancel buttons. The `notify_on_close` has to be `true` when opening/pushing the modal.|
41+
|**app.globalShortcut**|callback_id: **String** \| **Pattern**|[**Shortcuts**]({{ site.url | append: site.baseurl }}/guides/shortcuts): Responds to global shortcut invocations.|
42+
|**app.messageShortcut**|callback_id: **String** \| **Pattern**|[**Shortcuts**]({{ site.url | append: site.baseurl }}/guides/shortcuts): Responds to shortcut invocations in message menus.|
4243
|**app.dialogSubmission**|callback_id: **String** \| **Pattern**|**Dialogs**: Responds to data submissions in dialogs.|
4344
|**app.dialogSuggestion**|callback_id: **String** \| **Pattern**|**Dialogs**: Responds to requests to load options for `"external"` typed select menus in dialogs.|
4445
|**app.dialogCancellation**|callback_id **String** \| **Pattern**|**Dialogs**: Responds to the events where users close dialogs by clicking Cancel buttons.|
45-
|**app.attachmentAction**|callback_id: **String** \| **Pattern**|**Legacy Messaging**: Responds to user actions in **attachements**. These events can be triggered in only messages.|
46+
|**app.attachmentAction**|callback_id: **String** \| **Pattern**|**Legacy Messaging**: Responds to user actions in **attachments**. These events can be triggered in only messages.|
4647

4748
## Development Guides by Feature
4849

4950
On these guide pages, you'll find a more concrete example code for each.
5051

5152
* [**Slash Commands**]({{ site.url | append: site.baseurl }}/guides/slash-commands)
52-
* [**Actions**]({{ site.url | append: site.baseurl }}/guides/actions)
5353
* [**Interactive Components**]({{ site.url | append: site.baseurl }}/guides/interactive-components)
5454
* [**Modals**]({{ site.url | append: site.baseurl }}/guides/modals)
55+
* [**Shortcuts**]({{ site.url | append: site.baseurl }}/guides/shortcuts)
5556
* [**App Home**]({{ site.url | append: site.baseurl }}/guides/app-home)
5657
* [**Events API**]({{ site.url | append: site.baseurl }}/guides/events-api)
5758
* [**App Distribution (OAuth Flow)**]({{ site.url | append: site.baseurl }}/guides/app-distribution)

docs/guides/ja/actions.md

Lines changed: 0 additions & 138 deletions
This file was deleted.

docs/guides/ja/bolt-basics.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ app.command("/echo", (req, ctx) -> {
3434
|**app.event**|イベントデータ型: **Class\<Event\>**|[**イベント API**]({{ site.url | append: site.baseurl }}/guides/ja/events-api): 購読しているあらゆる bot/user events に応答します。|
3535
|**app.message**|キーワード: **String** \| **Pattern**|[**イベント API**]({{ site.url | append: site.baseurl }}/guides/ja/events-api): ユーザーからのメッセージ投稿で指定のキーワード・正規表現にマッチする bot/user events に応答します。|
3636
|**app.command**|コマンド名: **String** \| **Pattern**|[**スラッシュコマンド**]({{ site.url | append: site.baseurl }}/guides/ja/slash-commands): スラッシュコマンドの実行に応答します。|
37-
|**app.messageAction**|callback_id: **String** \| **Pattern**|[**アクション**]({{ site.url | append: site.baseurl }}/guides/ja/actions): メッセージメニューのアクション実行に応答します。|
3837
|**app.blockAction**|action_id: **String** \| **Pattern**|[**インタラクティブコンポーネント**]({{ site.url | append: site.baseurl }}/guides/ja/interactive-components): **blocks** 内でのボタンクリック、セレクトメニューからの選択、ラジオボタン選択などユーザクアションに応答します。これらのイベントは全てのサーフェスエリア(メッセージ、モーダル、Home タブ)で発火します。|
3938
|**app.blockSuggestion**|action_id: **String** \| **Pattern**|[**インタラクティブコンポーネント**]({{ site.url | append: site.baseurl }}/guides/ja/interactive-components): **blocks** 内の external data source を使ったセレクトメニュー内でユーザーが `min_query_length` 以上の長さのキーワードを入力したときに表示する選択肢を応答します。|
4039
|**app.viewSubmission**|callback_id: **String** \| **Pattern**|[**モーダル**]({{ site.url | append: site.baseurl }}/guides/ja/modals): Submit ボタンクリックによるデータ送信に応答します。|
4140
|**app.viewClosed**|callback_id: **String** \| **Pattern**|[**モーダル**]({{ site.url | append: site.baseurl }}/guides/ja/modals): ユーザーがモーダルを閉じたときのイベントに応答します。そのモーダルを open/push したときに `notify_on_close``true` に設定されている必要があります。|
41+
|**app.globalShortcut**|callback_id: **String** \| **Pattern**|[**ショートカット**]({{ site.url | append: site.baseurl }}/guides/ja/shortcuts): ショートカット実行に応答します。|
42+
|**app.messageShortcut**|callback_id: **String** \| **Pattern**|[**ショートカット**]({{ site.url | append: site.baseurl }}/guides/ja/shortcuts): メッセージメニューのショートカット実行に応答します。|
4243
|**app.dialogSubmission**|callback_id: **String** \| **Pattern**|**ダイアログ**: ダイアログでのデータ送信に応答します。|
4344
|**app.dialogSuggestion**|callback_id: **String** \| **Pattern**|**ダイアログ**: ダイアログ内での `"external"` type に設定されたセレクトメニューの選択肢読み込みのリクエストに応答します。|
4445
|**app.dialogCancellation**|callback_id **String** \| **Pattern**|**ダイアログ**: ダイアログが閉じたときのイベントに応答します。|
@@ -49,9 +50,9 @@ app.command("/echo", (req, ctx) -> {
4950
以下のガイドページで、それぞれの機能について具体的なコード例を見つけることができます。
5051

5152
* [**スラッシュコマンド**]({{ site.url | append: site.baseurl }}/guides/ja/slash-commands)
52-
* [**アクション**]({{ site.url | append: site.baseurl }}/guides/ja/actions)
5353
* [**インタラクティブコンポーネント**]({{ site.url | append: site.baseurl }}/guides/ja/interactive-components)
5454
* [**モーダル**]({{ site.url | append: site.baseurl }}/guides/ja/modals)
55+
* [**ショートカット**]({{ site.url | append: site.baseurl }}/guides/ja/shortcuts)
5556
* [**Home タブ**]({{ site.url | append: site.baseurl }}/guides/ja/app-home)
5657
* [**イベント API**]({{ site.url | append: site.baseurl }}/guides/ja/events-api)
5758
* [**アプリの配布 (OAuth Flow)**]({{ site.url | append: site.baseurl }}/guides/ja/app-distribution)

0 commit comments

Comments
 (0)