You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -54,6 +55,12 @@ Executes the command. Additional arguments are passed to the executing function
54
55
### command.getEnabled() ⇒ <code>boolean</code>
55
56
Is command enabled?
56
57
58
+
**Kind**: instance method of [<code>Command</code>](#Command)
59
+
<aname="Command+getOptions"></a>
60
+
61
+
### command.getOptions() ⇒ <code>object</code>
62
+
get the command options
63
+
57
64
**Kind**: instance method of [<code>Command</code>](#Command)
58
65
<aname="Command+setEnabled"></a>
59
66
@@ -87,7 +94,7 @@ Is command checked?
87
94
**Kind**: instance method of [<code>Command</code>](#Command)
88
95
<aname="Command+setName"></a>
89
96
90
-
### command.setName(name)
97
+
### command.setName(name, htmlName)
91
98
Sets the name of the Command and dispatches "nameChange" so that
92
99
UI that reflects the command name can update.
93
100
@@ -97,9 +104,10 @@ use \uXXXX instead of an HTML entity.
97
104
98
105
**Kind**: instance method of [<code>Command</code>](#Command)
99
106
100
-
| Param | Type |
101
-
| --- | --- |
102
-
| name | <code>string</code> |
107
+
| Param | Type | Description |
108
+
| --- | --- | --- |
109
+
| name | <code>string</code> ||
110
+
| htmlName | <code>string</code> | If set, this will be displayed in ui menus instead of the name given. Eg. "Phoenix menu<iclass='fa fa-car'style='margin-left: 4px;'></i>" |
103
111
104
112
<aname="Command+getName"></a>
105
113
@@ -156,6 +164,7 @@ Registers a global command.
156
164
| commandFn | <code>function</code> | the function to call when the command is executed. Any arguments passed to execute() (after the id) are passed as arguments to the function. If the function is asynchronous, it must return a jQuery promise that is resolved when the command completes. Otherwise, the CommandManager will assume it is synchronous, and return a promise that is already resolved. |
157
165
|[options]| <code>Object</code> ||
158
166
| options.eventSource | <code>boolean</code> | If set to true, the commandFn will be called with the first argument `event` with details about the source(invoker) as event.eventSource(one of the `CommandManager.SOURCE_*`) and event.sourceType(Eg. Ctrl-K) parameter. |
167
+
| options.htmlName | <code>string</code> | If set, this will be displayed in ui menus instead of the name given. Eg. "Phoenix menu<iclass='fa fa-car'style='margin-left: 4px;'></i>" |
0 commit comments