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
Copy file name to clipboardExpand all lines: docs/development/jump-menu.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Jumps are created via the CLI by using the `make:jump` command.
23
23
```
24
24
php eecli.php make:jump
25
25
Let's create an add-on Jump File!
26
-
What add-on is the Jumps file being added to? (amazing_add_on, cron,): [amazing_add_on]
26
+
What add-on is the Jumps file being added to? (amazing_add_on, cron): [amazing_add_on]
27
27
Building Add-on Jumps file now.
28
28
Jumps file successfully created! Please note: You may need to clear your browser cache before you can see the new jump menu items
29
29
@@ -38,28 +38,28 @@ amazing_add_on
38
38
┗ ...
39
39
```
40
40
41
-
Please note, your jump file will have the following:
41
+
Please note, your jump file will contain of the following:
42
42
43
43
use ExpressionEngine\Service\JumpMenu\AbstractJumpMenu;
44
44
45
45
class [AddonName]_jump extends AbstractJumpMenu
46
46
{
47
47
48
-
protected static $items = array(
49
-
'commandArrayTitle' => array(
50
-
'icon' => 'fa-file',
51
-
'command' => 'few lowercase words to be fuzzy-matched in jump menu',
52
-
'command_title' => 'Displayed <b>command title upon match from above</b>',
53
-
'dynamic' => false,
54
-
'requires_keyword' => false,
55
-
'target' => 'See Below. Behavior changes based on dynamic element above'
56
-
));
48
+
protected static $items = array(
49
+
'commandArrayTitle' => array(
50
+
'icon' => 'fa-file',
51
+
'command' => 'few lowercase words to be fuzzy-matched in jump menu',
52
+
'command_title' => 'Displayed <b>command title upon match from above</b>',
53
+
'dynamic' => false,
54
+
'requires_keyword' => false,
55
+
'target' => 'See Below. Behavior changes based on dynamic element above'
56
+
));
57
57
58
-
To Add Jump Menu commands to your add-on, you simply add array elements to the $items array in the example generated
58
+
To Add Jump Menu commands to your add-on, you simply add array elements to the `$items` array in the example generated
59
59
60
60
The array of a Jump Menu command is comprised of the following keys:
61
61
62
-
-`commandArrayTitle`_(string)_ Unique command title used as key in global jumps array. Will be prefixed with the add-ons name so a command title in the add-on Assets of `editS3Source` will be `Assets:editS3Source`
62
+
-`commandArrayTitle`_(string)_ Unique command title used as key in global jumps array. Will be prefixed with the add-ons name so a command title in the add-on AmazingAddOn of `processData` will be `AmazingAddon:processData`
63
63
-`icon`_(string)_ FontAwesome format: `fa-file`
64
64
-`command`_(string)_ lowercase string to be fuzzy-matched when user is typing in jump menu: “edit external source”
65
65
-`command_title`_(string)_ Language file array key for Human-readable command title, shows up in results if fuzzy-matched. *Please note, this should be in your Lang file.
0 commit comments