Syntax Tooltip
Syntax Tooltip
Beginner Mode — /join
Full detail: command header, description, context message, and examples. First param is active.
/join
<channel>
[key]
Join a channel, optionally with a password key.
Channel names begin with # or &
/join #lobby
/join #private secretkey
<.syntax_tooltip
tooltip={%{
command: "join",
parameters: [%{name: "channel", required: true}, %{name: "key", required: false}],
current_param_index: 0,
description: "Join a channel",
sub_options: [],
context_message: "Channel names begin with # or &",
examples: ["/join #lobby"]
}}
detail_level={:beginner}
/>
Beginner Mode — /kick (with sub-options)
Shows sub-options list. Second param (nick) is active.
/kick
<channel>
<nick>
[reason]
Kick a user from a channel. Requires operator status.
-q
Quiet — do not display kick message
-b
Also ban the user after kicking
You must be a channel operator to use this command.
/kick #lobby spammer
/kick #lobby troll Violating rules
Expert Mode — /msg
Expert mode: command header only, no description or examples.
/msg
<target>
<message>
<.syntax_tooltip tooltip={@tooltip} detail_level={:expert} />
Off Mode
When detail_level is :off, nothing is rendered.
(Nothing rendered below — tooltip is hidden)
<.syntax_tooltip tooltip={@tooltip} detail_level={:off} />
Nil Tooltip
When tooltip is nil (e.g. user hasn't typed a command yet), nothing is rendered.
(Nothing rendered below — tooltip is nil)
Language
14 objects
