# Help Button

A circular help button with a question mark glyph.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<ComponentPreview name="help-button/Basic" />

## Import [#import]

```rust
use maccn::MacHelpButton;
```

## Usage [#usage]

```rust
MacHelpButton::new("help")
    .on_click(|_, _, _| {
        println!("Help clicked");
    });
```

## Sizes [#sizes]

<ComponentPreview name="help-button/Sizes" />

```rust
use gpui::div;
use maccn::{MacControlSize, MacHelpButton};

div()
    .flex()
    .items_center()
    .gap_2()
    .child(MacHelpButton::new("help-xl").size(MacControlSize::ExtraLarge))
    .child(MacHelpButton::new("help-l").size(MacControlSize::Large))
    .child(MacHelpButton::new("help-r"))
    .child(MacHelpButton::new("help-s").size(MacControlSize::Small))
    .child(MacHelpButton::new("help-m").size(MacControlSize::Mini))
```

## Disabled [#disabled]

<ComponentPreview name="help-button/Disabled" />

```rust
MacHelpButton::new("help-d").disabled(true)
```

## API [#api]

### Props [#props]

| Prop       | Type             | Default   |
| ---------- | ---------------- | --------- |
| `size`     | `MacControlSize` | `Regular` |
| `disabled` | `bool`           | `false`   |

### Events [#events]

| Event      | Payload                                |
| ---------- | -------------------------------------- |
| `on_click` | `(&ClickEvent, &mut Window, &mut App)` |
