Packages
livebook
0.5.2
0.19.8
0.19.7
0.19.6
0.19.5
0.19.4
0.19.3
0.19.2
0.19.1
0.19.0
0.18.6
0.18.5
0.18.4
0.18.3
0.18.2
0.18.1
0.18.0
0.17.3
0.17.2
0.17.1
0.17.0
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.14.0-rc.1
0.14.0-rc.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.1
0.12.0
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.2
0.8.1
0.8.0
0.7.2
0.7.1
0.7.0
0.6.3
0.6.2
0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.2
0.1.1
0.1.0
Automate code & data workflows with interactive notebooks
Current section
Files
Jump to
Current section
Files
lib/livebook_web/live/session_live/shortcuts_component.ex
defmodule LivebookWeb.SessionLive.ShortcutsComponent do
use LivebookWeb, :live_component
@shortcuts %{
insert_mode: [
%{seq: ["esc"], desc: "Switch back to navigation mode", basic: true},
%{seq: ["tab"], desc: "Autocomplete expression when applicable", basic: true},
%{
seq: ["ctrl", "␣"],
press_all: true,
desc: "Show completion list, use twice for details",
basic: true
},
%{
seq: ["ctrl", "shift", "␣"],
seq_mac: ["⌘", "⇧", "␣"],
press_all: true,
desc: "Show signature help"
},
%{
seq: ["ctrl", "shift", "i"],
seq_mac: ["⇧", "⌥", "f"],
seq_windows: ["shift", "alt", "f"],
press_all: true,
desc: "Format Elixir code",
basic: true
},
%{
seq: ["ctrl", "/"],
seq_mac: ["⌘", "/"],
press_all: true,
desc: "Toggle lines comment"
},
%{
seq: ["ctrl", "shift", "k"],
seq_mac: ["⌘", "⇧", "k"],
press_all: true,
desc: "Delete lines"
},
%{
seq: ["ctrl", "]"],
seq_mac: ["⌘", "]"],
press_all: true,
desc: "Indent lines"
},
%{
seq: ["ctrl", "["],
seq_mac: ["⌘", "["],
press_all: true,
desc: "Outdent lines"
},
%{
seq: ["ctrl", "h"],
seq_mac: ["⌘", "⌥", "f"],
press_all: true,
desc: "Replace"
},
%{
seq: ["alt", "↑"],
seq_mac: ["⌥", "↑"],
press_all: true,
desc: "Move lines up"
},
%{
seq: ["alt", "↓"],
seq_mac: ["⌥", "↓"],
press_all: true,
desc: "Move lines down"
},
%{
seq: ["ctrl", "←"],
seq_mac: ["⌥", "←"],
press_all: true,
desc: "Cursor skip word left"
},
%{
seq: ["ctrl", "→"],
seq_mac: ["⌥", "→"],
press_all: true,
desc: "Cursor skip word right"
}
],
navigation_mode: [
%{seq: ["?"], desc: "Open this help modal", basic: true},
%{seq: ["j"], desc: "Focus next cell", basic: true},
%{seq: ["k"], desc: "Focus previous cell", basic: true},
%{seq: ["J"], desc: "Move cell down"},
%{seq: ["K"], desc: "Move cell up"},
%{seq: ["i"], desc: "Switch to insert mode", basic: true},
%{seq: ["n"], desc: "Insert Elixir cell below", basic: true},
%{seq: ["m"], desc: "Insert Markdown cell below", basic: true},
%{seq: ["N"], desc: "Insert Elixir cell above"},
%{seq: ["M"], desc: "Insert Markdown cell above"},
%{seq: ["d", "d"], desc: "Delete cell", basic: true},
%{seq: ["e", "e"], desc: "Evaluate cell"},
%{seq: ["e", "s"], desc: "Evaluate section"},
%{seq: ["e", "a"], desc: "Evaluate all outdated cells", basic: true},
%{seq: ["e", "x"], desc: "Cancel cell evaluation"},
%{seq: ["s", "s"], desc: "Toggle sections panel"},
%{seq: ["s", "u"], desc: "Toggle users panel"},
%{seq: ["s", "r"], desc: "Show runtime settings"},
%{seq: ["s", "b"], desc: "Show bin"},
%{seq: ["0", "0"], desc: "Restart current runtime"}
],
universal: [
%{
seq: ["ctrl", "↵"],
seq_mac: ["⌘", "↵"],
press_all: true,
desc: "Evaluate cell in either mode",
basic: true
},
%{
seq: ["ctrl", "shift", "↵"],
seq_mac: ["⌘", "⇧", "↵"],
press_all: true,
desc: "Evaluate current and all outdated cells",
basic: true
},
%{
seq: ["ctrl", "s"],
seq_mac: ["⌘", "s"],
press_all: true,
desc: "Save notebook",
basic: true
}
]
}
@impl true
def mount(socket) do
{:ok, assign(socket, shortcuts: @shortcuts, basic: false)}
end
@impl true
def render(assigns) do
~H"""
<div class="p-6 flex flex-col space-y-3">
<h3 class="text-2xl font-semibold text-gray-800">
Keyboard shortcuts
</h3>
<p class="text-gray-700">
Livebook highly embraces keyboard navigation to improve your productivity.
It operates in one of two modes similarly to the Vim text editor.
In <span class="font-semibold">navigation mode</span> you move around
the notebook and execute commands, whereas in the <span class="font-semibold">insert mode</span>
you have editor focus and directly modify the given cell content.
</p>
<div class="flex">
<form class="mt-4" phx-change="settings" onsubmit="return false;" phx-target={@myself}>
<.switch_checkbox
name="basic"
label="Basic view (essential shortcuts only)"
checked={@basic} />
</form>
</div>
<.shortcuts_section title="Navigation mode" shortcuts={@shortcuts.navigation_mode} basic={@basic} platform={@platform} />
<.shortcuts_section title="Insert mode" shortcuts={@shortcuts.insert_mode} basic={@basic} platform={@platform} />
<.shortcuts_section title="Universal" shortcuts={@shortcuts.universal} basic={@basic} platform={@platform} />
</div>
"""
end
defp shortcuts_section(assigns) do
shortcuts =
if assigns.basic do
Enum.filter(assigns.shortcuts, & &1[:basic])
else
assigns.shortcuts
end
{left, right} = split_in_half(shortcuts)
assigns = assign(assigns, left: left, right: right)
~H"""
<h3 class="text-lg font-medium text-gray-900 pt-4">
<%= @title %>
</h3>
<div class="mt-2 flex flex-col lg:flex-row lg:space-x-4">
<div class="lg:grow">
<.shortcuts_section_table shortcuts={@left} platform={@platform} />
</div>
<div class="lg:w-1/2">
<.shortcuts_section_table shortcuts={@right} platform={@platform} />
</div>
</div>
"""
end
defp shortcuts_section_table(assigns) do
~H"""
<table>
<tbody>
<%= for shortcut <- @shortcuts do %>
<tr>
<td class="py-2 pr-3">
<.shortcut shortcut={shortcut} platform={@platform} />
</td>
<td class="lg:whitespace-nowrap">
<%= shortcut.desc %>
</td>
</tr>
<% end %>
</tbody>
</table>
"""
end
defp shortcut(%{shortcut: shortcut, platform: platform}) do
seq = shortcut[:"seq_#{platform}"] || shortcut.seq
press_all = Map.get(shortcut, :press_all, false)
joiner =
if press_all do
assigns = %{}
~H"""
<.remix_icon icon="add-line" class="text-lg text-gray-600" />
"""
end
elements = Enum.map_intersperse(seq, joiner, &content_tag("kbd", &1))
assigns = %{elements: elements}
~H"""
<div class="flex space-x-1 items-center markdown">
<%= for element <- @elements do %>
<%= element %>
<% end %>
</div>
"""
end
defp split_in_half(list) do
half_idx = list |> length() |> Kernel.+(1) |> div(2)
Enum.split(list, half_idx)
end
@impl true
def handle_event("settings", %{"basic" => basic}, socket) do
basic? = basic == "true"
{:noreply, assign(socket, :basic, basic?)}
end
end