# obsidian-focus-mode

**Repository Path**: funckzs/obsidian-focus-mode

## Basic Information

- **Project Name**: obsidian-focus-mode
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-29
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Obsidian Focus Mode

Add Focus Mode to Obsidian.

![Focus Mode Demo](https://raw.githubusercontent.com/ryanpcmcquen/obsidian-focus-mode/master/obsidian-super-focus-mode-demo-v2.gif)

Now with _Super Focus Mode_ (<kbd>Shift</kbd> + `Left Click`), which will only focus on the active pane. The original behavior still exists on a normal `Left Click`.

![Super Focus Mode and Command/Hotkey demo](https://raw.githubusercontent.com/ryanpcmcquen/obsidian-focus-mode/master/obsidian-command-focus-mode-demo-v1.gif)

### Hotkeys

| Hotkeys                                                                | Action                                     |
| ---------------------------------------------------------------------- | ------------------------------------------ |
| <kbd>Cmd/Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Z</kbd>                    | Toggle Focus Mode                          |
| <kbd>Cmd/Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Shift</kbd> + <kbd>Z</kbd> | Toggle Super Focus Mode (Active pane only) |

---

### Customizing the plugin's appearance:

Classes are added to `document.body` depending on the state. `focus-mode` exists in Normal and Super Focus modes, while `super-focus-mode`, only exists in Super Focus Mode (surprise!).

The following CSS snippet added to a vault will remove the opacity on non-active lines:

```css
.focus-mode .cm-s-obsidian .cm-line:not(.cm-active),
.focus-mode .cm-s-obsidian div:not(.CodeMirror-activeline) > .CodeMirror-line {
    opacity: 1 !important;
    filter: saturate(1) !important;
}
```

---

### Manually installing the plugin:

-   Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/obsidian-focus-mode/`.