# RichMark

Source: /tuil/docs/reference/packages/editor/api/rich-mark
Locale: en

interface exported by @mwillbanks/tuil-editor.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-editor`.

```ts
export interface RichMark {
  readonly [key: string]: unknown;
  readonly type: "bold" | "italic" | "code" | "strike" | "link" | (string & {});
  readonly attributes?: Readonly<Record<string, string>>;
}
```

## Members [#members]

| Member       | Type                                                                            | Required | Description                                                                                                          | Related types |
| ------------ | ------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------- | ------------- |
| `type`       | `"link" \| (string & &#123;&#125;) \| "bold" \| "italic" \| "code" \| "strike"` | Yes      | The `type` member uses the `"link" \| (string & &#123;&#125;) \| "bold" \| "italic" \| "code" \| "strike"` contract. | —             |
| `attributes` | `Readonly<Record<string, string>> \| undefined`                                 | No       | The `attributes` member uses the `Readonly<Record<string, string>> \| undefined` contract.                           | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/editor/src/rich.ts)

## Package [#package]

[@mwillbanks/tuil-editor](/tuil/docs/reference/packages/editor)