Keyboard functions and shortcuts

Navigating around the style editor interface is easy with the mouse, but there are some useful keyboard functions available that can make using Composer even easier.

Function Shortcut
Save Ctrl + S
Autocomplete Ctrl + Enter
Code fold / unfold Ctrl + , / Ctrl + .
Comment / uncomment Ctrl + 3
Select line Shift + Up and Shift + Down
Increase / reduce indent Tab / Shift + Tab

This list can be retrieved by clicking the keyboard icon on the top right of the window.

../../_images/keys_listicon.png

Icon to show keyboard shortcuts

The resulting list will be displayed.

../../_images/keys_list.png

List of keyboard shortcuts

Save (Ctrl + S)

Like many typical programs, you can save your progress by pressing Ctrl + S (Cmd + S on OS X).

If there are no errors, you will see a Style saved note at the top of the window.

../../_images/saved.png

Style saved

If there is an error, the line that contains the error will be highlighted, and any other details known about the error will be listed.

Auto-complete (Ctrl + Enter)

The style editor offers an easy way to explore and determine the correct syntax for functions by way of an auto-complete function.

Auto-complete is activated by pressing Ctrl + Enter (Cmd + Enter on OS X). A drop-down list will display showing a list of possible options. The location of the cursor and the context will determine what goes in this list.

../../_images/keys_auto.png

Auto-complete

This can also be useful during debugging, as you can verify if an option is in the right place by verifying that it appears in the appropriate list.

Not only does the auto-complete respect cursor location, but it also respects whether the expected option will be a list, a mapping, or a value.

Note

Read more about lists, mappings, and more YSLD structure.

When auto-complete is triggered on a list item (noted by the dash prefix), only list options will be shown:

../../_images/keys_autolist.png

Auto-complete on a list

Removing the dash and triggering auto-complete will show only mapping entries:

../../_images/keys_automapping.png

Auto-complete on a mapping

When auto-complete is triggered on a value with a finite number of possible values, the list of values will be shown:

../../_images/keys_autocolor.png

Auto-complete on a named color

When auto-complete is triggered on a value with an infinite number of possible values, a hint will be shown:

../../_images/keys_autonumber.png

Auto-complete on a number

Code folding (Ctrl + , / Ctrl + .)

It can sometimes be useful to hide and display certain portions of the code. This is known as “code folding”.

Code folding is activated by pressing Ctrl + , (Cmd + , on OS X). The code to be folded is dependent on where the cursor is.

When the cursor is on a line that contains a list entry (with the dash) the entire contents of that list entry will be folded.

../../_images/keys_foldbefore.png

List entry before folding

../../_images/keys_foldafter.png

List entry folded

When the cursor is on a line that is inside a mapping (no dash), then the contents of the parent will be folded. In this case, the cursor will move to the parent line from the (now-hidden) original line.

Note

Read more about lists, mappings, and more YSLD structure.

Code that is folded is indicated by a doublearrow at the end of a line, with a small arrow shown in the margin area to the left of the line. Placing the cursor on this line and pressing Ctrl + . (Cmd + . on OS X) will unfold the code. You can also click the doublearrow icon to unfold the code. Attempting to navigate into the folded region using the arrow keys will also unfold the code.

As another indicator of code folding, the line numbers in the margin will become discontinuous.

Note

It is not possible to force folding using tokens or regions.

Comment/uncomment selection (Ctrl + 3)

It may be useful to comment out a block of text so that it does not affect the style. This can be done by selecting the text to be commented and pressing Ctrl + 3. All lines selected (or partially selected) will then have a # added to the beginning of the line, indicating that the line is now commented out.

This can be reversed by selecting the commented text and pressing Ctrl + 3 again.

Select line (Shift + Up and Shift + Down)

As in many other programs, holding Shift and moving the cursor with the arrow keys will select all characters between the original cursor position and the new cursor position. By this method, Shift + Up will select the previous line and Shift + Down will select the next line. Shift + Left will select the previous character and Shift + Right will select the next character.

Increase/reduce indent (Tab and Shift + Tab)

Since proper indenting is so crucial to YSLD syntax, it can be useful to change the indentation of a block of text together. Selecting a block of text and then pressing Tab will increase the indentation of all selected lines by two spaces. Pressing Shift + Tab will decrease the indentation of all selected lines by two spaces.