Skip to content
This repository was archived by the owner on Nov 6, 2024. It is now read-only.

Commit e08cceb

Browse files
authored
fix: improve icons with fontawesome in widgets (#74)
1 parent 54ce41a commit e08cceb

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/widgets.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ Every individual Component is contained in its own widget. These can be added, r
1111
Adding a widget can be done using the widget bar on the right hand side of the window. This will add a widget of the selected type to the current tab.
1212

1313
### How to Close a Widget
14-
Widgets can be closed by clicking the ✕ button on the right side of the header. Alternatively, the currently focused widget can be closed by pressing `Cmd + w`.
14+
Widgets can be closed by clicking the **<code><i className="fa-solid fa-sharp fa-xmark"/></code>** button on the right side of the header. Alternatively, the currently focused widget can be closed by pressing **`Cmd + w`**.
1515

1616
### How to Navigate Widgets
17-
At most, it is possible to have one widget be focused. Depending on the type of widget, this allows you to directly interact with the content in that widget. A focused widget is always outlined with a distinct border. A widget may be focused by clicking on it. Alternatively, you can change the focused widget by pressing <code>Ctrl + Shift + &uarr;</code>, <code>Ctrl + Shift + &darr;</code>, <code>Ctrl + Shift + &larr;</code>, or <code>Ctrl + Shift + &rarr;</code>to navigate relative to the currently selected widget.
17+
At most, it is possible to have one widget be focused. Depending on the type of widget, this allows you to directly interact with the content in that widget. A focused widget is always outlined with a distinct border. A widget may be focused by clicking on it. Alternatively, you can change the focused widget by pressing **<code>Ctrl + Shift + <i className="fa-regular fa-sharp fa-arrow-up"/></code>**, **<code>Ctrl + Shift + <i className="fa-regular fa-sharp fa-arrow-down"/></code>**, **<code>Ctrl + Shift + <i className="fa-regular fa-sharp fa-arrow-left"/></code>**, or **<code>Ctrl + Shift + <i className="fa-regular fa-sharp fa-arrow-right"/></code>** to navigate relative to the currently selected widget.
1818

1919
### How to Magnify Widgets
20-
Magnifying a widget will pop the widget out in front of everything else. You can magnify using the header icon, or with `Cmd + m`.
20+
Magnifying a widget will pop the widget out in front of everything else. You can magnify using the header icon, or with **`Cmd + m`**.
2121

2222
### How to Reorganize Widgets
2323
By dragging and dropping their headers, widgets can be moved to different locations in the layout. This effectively allows you to reorganize your screen however you see fit. When dragging, you will see a preview of the widget that is being dragged. When the widget is over a valid drop point, the area where it would be moved to will turn green. Releasing the click will place the widget there and reflow the other widgets around it. If you see a green box cover half of two different widgets, the drop will place the widget between the two. If you see the green box cover half of one widget at the edge of the screen, the widget will be placed between that widget and the edge of the screen. If you see the green box cover one widget entirely, the two widgets will swap locations.
2424

2525
### How to Resize Widgets
26-
Hovering the mouse between two widgets changes your cursor to &harr; and reveals a green line dividing the widgets. By dragging and dropping this green line, you are able to resize the widgets adjacent to it.
26+
Hovering the mouse between two widgets changes your cursor to <i className="fa-sharp fa-arrows-left-right"/> or <i className="fa-sharp fa-arrows-up-down"/>; and reveals a green line dividing the widgets. By dragging and dropping this green line, you are able to resize the widgets adjacent to it.
2727

2828
## Types of Widgets
2929

@@ -38,31 +38,31 @@ You can use \`wsh view [path]\` from any Wave terminal window to open a preview
3838
When looking at a directory, preview will show a file viewer much like MacOS' *Finder* application or Windows' *File Explorer* application. This variant is slightly more geared toward software development with the focus on seeing what is shown by the `ls -alh` command.
3939

4040
##### View a New File
41-
The simplest way to view a new file is to double click its row in the file viewer. Alternatively, while the widget is focused, you can use the &uarr; and &darr; arrow keys to select a row and press enter to preview the associated file.
41+
The simplest way to view a new file is to double click its row in the file viewer. Alternatively, while the widget is focused, you can use the **<code><i className="fa-regular fa-sharp fa-arrow-up"/></code>** and **<code><i className="fa-regular fa-sharp fa-arrow-down"/></code>** arrow keys to select a row and press enter to preview the associated file.
4242

4343
##### View the Parent Directory
44-
In the directory view, this is as simple as opening the `..` file as if it were a regular file. This can be done with the method above. You can also use the keyboard shortcut <code>Cmd + &uarr;</code>.
44+
In the directory view, this is as simple as opening the `..` file as if it were a regular file. This can be done with the method above. You can also use the keyboard shortcut **<code>Cmd + <i className="fa-regular fa-sharp fa-arrow-up"/></code>**.
4545

4646
##### Navigate Back and Forward
47-
When looking at a file, you can navigate back by clicking the back button in the widget header or the keyboard shortcut <code>Cmd + &larr;</code>. You can always navigate back and forward using <code>Cmd + &larr;</code> and <code>Cmd + &rarr;</code>.
47+
When looking at a file, you can navigate back by clicking the back button in the widget header or the keyboard shortcut **<code>Cmd + <i className="fa-regular fa-sharp fa-arrow-left"/></code>**. You can always navigate back and forward using **<code>Cmd + <i className="fa-regular fa-sharp fa-arrow-left"/></code>** and **<code>Cmd + <i className="fa-regular fa-sharp fa-arrow-right"/></code>**.
4848

4949
##### Filter the List of Files
50-
While the widget is focused, you can filter by filename by typing a substring of the filename you're working for. To clear the filter, you can click the &#x2715; on the filter dropdown or press esc.
50+
While the widget is focused, you can filter by filename by typing a substring of the filename you're working for. To clear the filter, you can click the **<code><i className="fa-solid fa-sharp fa-xmark"/></code>** on the filter dropdown or press **`Esc`**.
5151

5252
##### Sort by a File Column
5353
To sort a file by a specific column, click on the header for that column. If you click the header again, it will reverse the sort order.
5454

5555
##### Hide and Show Hidden Files
56-
At the right of the widget header, there is an &#128065;&#65039; button. Clicking this button hides and shows hidden files.
56+
At the right of the widget header, there is an **<code><i className="fa fa-sharp fa-solid fa-eye"/></code>** button. Clicking this button hides and shows hidden files.
5757

5858
##### Refresh the Directory
59-
At the right of the widget header, there is a refresh button. Clicking this button refreshes the directory contents.
59+
At the right of the widget header, there is a refresh button **<code><i className="fa fa-sharp fa-solid fa-arrows-rotate" /></code>**. Clicking this button refreshes the directory contents.
6060

6161
##### Navigate to Common Directories
62-
At the left of the widget header, there is a file icon. Clicking and holding on this icon opens a menu where you can select a common folder to navigate to. The available options are *Home*, *Desktop*, *Downloads*, and *Root*.
62+
At the left of the widget header, there is a file icon **<code><i className="fa fa-sharp fa-solid fa-folder-open"/></code>**. Clicking and holding on this icon opens a menu where you can select a common folder to navigate to. The available options are *Home*, *Desktop*, *Downloads*, and *Root*.
6363

6464
##### Open a New Terminal in the Current Directory
65-
If you right click the header of the widget (alternatively, click the gear icon), one of the menu items listed is **Open Terminal in New Widget**. This will create a new terminal widget at your current directory.
65+
If you right click the header of the widget (alternatively, click the gear icon **<code><i className="fa fa-sharp fa-solid fa-cog"/></code>**), one of the menu items listed is **Open Terminal in New Widget**. This will create a new terminal widget at your current directory.
6666

6767
##### Open a New Terminal in a Child Directory
6868
If you want to open a terminal for a child directory instead, you can right click on that file's row to get the **Open Terminal in New Widget** option. Clicking this will open a terminal at that directory. Note that this option is only available for children that are directories.
@@ -72,7 +72,7 @@ To open a new Preview Widget for a Child, you can right click on that file's row
7272

7373

7474
##### Quick Look (MacOS only)
75-
On a MacOS host, it is possible to use the Quick Look feature from the directory preview. To do this, select the file you wish to view and press `Space`. This will open a preview of your file in a separate window. This preview can then be closed by pressing `Space` again. This currently supports the filetypes that can be accessed by the `qlmanage` command.
75+
On a MacOS host, it is possible to use the Quick Look feature from the directory preview. To do this, select the file you wish to view and press **`Space`**. This will open a preview of your file in a separate window. This preview can then be closed by pressing **`Space`** again. This currently supports the filetypes that can be accessed by the `qlmanage` command.
7676

7777
#### Markdown
7878
Opening a markdown file will bring up a view of the rendered markdown. These files cannot be edited in the preview at this time.
@@ -82,17 +82,17 @@ Opening a picture will bring up the image of that picture. Opening a video will
8282

8383
### Codeedit
8484
Opening most text files will open Codeedit to either view or edit the file. It is technically part of the Preview widget, but it is important enough to be singled out.
85-
After opening a codeedit widget, it is often useful to magnify it (`Cmd + m`) to get a larger view. You can then
86-
use the hotkeys below to switch to edit mode, make your edits, save, and then use `Cmd + w` to close the widget (all without using the mouse!).
85+
After opening a codeedit widget, it is often useful to magnify it (**`Cmd + m`**) to get a larger view. You can then
86+
use the hotkeys below to switch to edit mode, make your edits, save, and then use **`Cmd + w`** to close the widget (all without using the mouse!).
8787

8888
#### Switch to Edit Mode
8989
To switch to edit mode, click the edit button to the right of the header. This lets you edit the file contents with a regular monaco editor.
90-
You can also switch to edit mode by pressing `Cmd + e`.
90+
You can also switch to edit mode by pressing **`Cmd + e`**.
9191

9292
#### Save an Edit
9393
Once an edit has been made in **edit mode**, click the save button to the right of the header to save the contents.
94-
You can also save by pressing `Cmd + s`.
94+
You can also save by pressing **`Cmd + s`**.
9595

9696
#### Exit Edit Mode Without Saving
9797
To exit **edit mode** without saving, click the cancel button to the right of the header.
98-
You can also exit without saving by pressing `Cmd + r`.
98+
You can also exit without saving by pressing **`Cmd + r`**.

0 commit comments

Comments
 (0)