> From the [Strife developer docs](https://strife.app/docs/reference/field-reference/fields.hint). Every page is listed in [llms.txt](https://strife.app/docs/llms.txt).

# fields.hint()

UI-only informational hint box. Stores no data — omitted from the generated content type.

Informational hint box. Maps to editor `{ name: 'str-hint', type: 'hint' }`.

A hint is pure editor-UI chrome: it stores no data, so its output type is `never` and `Infer<>` omits it from the generated content interface entirely (`strife typegen generate` skips it too). Place it in `fields` — for declaration order and tab membership — like any other field.

## Example

```ts
fields.hint({
  label: 'Content guidelines',
  icon: 'info',
  collapsedText: 'Keep headings under 60 characters.',
  expandedText: 'Search engines truncate headings past ~60 characters. Keep the important words first.',
})
```

## Options

| Option          | Type             | Required | Description                                                                                                                |
| --------------- | ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| `label`         | `string`         | Yes      | The hint's header text, shown next to the icon.                                                                            |
| `description`   | `string`         | No       | Not rendered distinctly from `expandedText` in practice — prefer `collapsedText`/`expandedText` for the visible hint copy. |
| `propertyName`  | `string`         | No       | Rarely needed since hints store no data — present for consistency with other builders.                                     |
| `icon`          | `string \| null` | No       | Icon shown next to the label (icon-picker name).                                                                           |
| `collapsedText` | `string \| null` | No       | Text shown when the hint is collapsed.                                                                                     |
| `expandedText`  | `string \| null` | No       | Text shown when the hint is expanded.                                                                                      |

> [!NOTE]
> Unlike every data-storing field, `HintOptions` has **no** `searchable`, `filterable`, `protected`, or `localizable` — there's no value to search, filter, protect, or localize.

## Output type

`never` — excluded from `Infer<>` and from generated types.

## See also

* [Hint](https://strife.app/docs/reference/fields/hint.md) — the same editor, documented from the Strife Studio UI side.