Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/website/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ const EXAMPLES_SIDEBAR = [
text: "Changing Font",
link: "/examples/changing-font",
},
{
text: "Formatting Toolbar Buttons",
link: "/examples/formatting-toolbar-buttons",
},
],
},
{
Expand Down
104 changes: 104 additions & 0 deletions packages/website/docs/examples/formatting-toolbar-buttons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
title: Formatting Toolbar Buttons
description: In this example, we change add a code styles button to the formatting toolbar.
imageTitle: Formatting Toolbar Buttons
path: /examples/formatting-toolbar-buttons
---

<script setup>
import { useData } from 'vitepress';
import { getTheme, getStyles } from "../demoUtils";

const { isDark } = useData();
</script>

# Formatting Toolbar Buttons

In this example, we add a code style toggle button to the Formatting Toolbar.

**Relevant Docs:**

- [Custom Formatting Toolbar](/docs/formatting-toolbar#custom-formatting-toolbar)

::: sandbox {template=react-ts}

```typescript-vue /App.tsx
import { BlockNoteEditor } from "@blocknote/core";
import {
BlockNoteView,
BlockTypeDropdown,
ColorStyleButton,
CreateLinkButton,
FormattingToolbarPositioner,
FormattingToolbarProps,
HyperlinkToolbarPositioner,
ImageCaptionButton,
ImageToolbarPositioner,
NestBlockButton,
ReplaceImageButton,
SideMenuPositioner,
SlashMenuPositioner,
TableHandlesPositioner,
TextAlignButton,
ToggledStyleButton,
Toolbar,
UnnestBlockButton,
useBlockNote,
} from "@blocknote/react";
import "@blocknote/react/style.css";

// From https://github.com/TypeCellOS/BlockNote/blob/main/packages/react/src/components/FormattingToolbar/DefaultFormattingToolbar.tsx
function CustomFormattingToolbar(props: FormattingToolbarProps) {
return (
<Toolbar>
<BlockTypeDropdown {...props} />

<ImageCaptionButton editor={props.editor} />
<ReplaceImageButton editor={props.editor} />

<ToggledStyleButton editor={props.editor} toggledStyle={"bold"} />
<ToggledStyleButton editor={props.editor} toggledStyle={"italic"} />
<ToggledStyleButton editor={props.editor} toggledStyle={"underline"} />
<ToggledStyleButton editor={props.editor} toggledStyle={"strike"} />
{/* Added code toggle button */}
<ToggledStyleButton editor={props.editor} toggledStyle={"code"} />

<TextAlignButton editor={props.editor as any} textAlignment={"left"} />
<TextAlignButton editor={props.editor as any} textAlignment={"center"} />
<TextAlignButton editor={props.editor as any} textAlignment={"right"} />

<ColorStyleButton editor={props.editor} />

<NestBlockButton editor={props.editor} />
<UnnestBlockButton editor={props.editor} />

<CreateLinkButton editor={props.editor} />
</Toolbar>
);
}

export default function App() {
// Creates a new editor instance.
const editor: BlockNoteEditor = useBlockNote();

// Renders the editor instance using a React component.
return (
<BlockNoteView editor={editor} theme={"{{ getTheme(isDark) }}"}>
<FormattingToolbarPositioner
editor={editor}
formattingToolbar={CustomFormattingToolbar}
/>
<HyperlinkToolbarPositioner editor={editor} />
<SlashMenuPositioner editor={editor} />
<SideMenuPositioner editor={editor} />
<ImageToolbarPositioner editor={editor} />
<TableHandlesPositioner editor={editor} />
</BlockNoteView>
);
}

```

```css-vue /styles.css [hidden]
{{ getStyles(isDark) }}
```