# `Minga.Extension.Overlay`
[🔗](https://github.com/jsmestad/minga/blob/main/sdk/lib/minga/extension/overlay.ex#L1)

Registry for extension-owned overlays on the editor surface.

Extensions register overlays anchored to buffer positions. The editor
reads this registry during rendering and displays the overlays on the
appropriate frontend surface.

This is a compile-time stub. At runtime, the real module in Minga's
BEAM VM provides the implementation.

# `entry`

```elixir
@type entry() :: %{
  extension: atom(),
  overlay_id: term(),
  buffer: pid(),
  position: {non_neg_integer(), non_neg_integer()},
  content: String.t(),
  style: style(),
  shape: shape()
}
```

# `shape`

```elixir
@type shape() :: :cursor | :cursor_with_label | :label | :indicator
```

# `style`

```elixir
@type style() :: %{optional(:fg) =&gt; non_neg_integer(), optional(:opacity) =&gt; 0..255}
```

# `all`

```elixir
@spec all() :: [entry()]
```

# `empty?`

```elixir
@spec empty?() :: boolean()
```

# `for_buffer`

```elixir
@spec for_buffer(pid()) :: [entry()]
```

# `remove`

```elixir
@spec remove(atom(), term()) :: :ok
```

# `remove_all`

```elixir
@spec remove_all(atom()) :: :ok
```

# `set`

```elixir
@spec set(atom(), term(), pid(), keyword()) :: :ok
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*
