Skip to content

refactor: reuse toolbar types and extract mantine context #1440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2025
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
31 changes: 31 additions & 0 deletions packages/ariakit/src/BlockNoteView.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import {
BlockSchema,
InlineContentSchema,
mergeCSSClasses,
StyleSchema,
} from "@blocknote/core";
import {
BlockNoteViewProps,
BlockNoteViewRaw,
ComponentsContext,
} from "@blocknote/react";
import { components } from "./components.js";

export const BlockNoteView = <
BSchema extends BlockSchema,
ISchema extends InlineContentSchema,
SSchema extends StyleSchema
>(
props: BlockNoteViewProps<BSchema, ISchema, SSchema>
) => {
const { className, ...rest } = props;

return (
<ComponentsContext.Provider value={components}>
<BlockNoteViewRaw
className={mergeCSSClasses("bn-ariakit", className || "")}
{...rest}
/>
</ComponentsContext.Provider>
);
};
97 changes: 97 additions & 0 deletions packages/ariakit/src/components.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
import { Components } from "@blocknote/react";

import { Form } from "./input/Form.js";
import { TextInput } from "./input/TextInput.js";
import {
Menu,
MenuDivider,
MenuDropdown,
MenuItem,
MenuLabel,
MenuTrigger,
} from "./menu/Menu.js";
import { Panel } from "./panel/Panel.js";
import { PanelButton } from "./panel/PanelButton.js";
import { PanelFileInput } from "./panel/PanelFileInput.js";
import { PanelTab } from "./panel/PanelTab.js";
import { PanelTextInput } from "./panel/PanelTextInput.js";
import { Popover, PopoverContent, PopoverTrigger } from "./popover/Popover.js";
import { SideMenu } from "./sideMenu/SideMenu.js";
import { SideMenuButton } from "./sideMenu/SideMenuButton.js";
import { GridSuggestionMenu } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenu.js";
import { GridSuggestionMenuEmptyItem } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenuEmptyItem.js";
import { GridSuggestionMenuItem } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenuItem.js";
import { GridSuggestionMenuLoader } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenuLoader.js";
import { SuggestionMenu } from "./suggestionMenu/SuggestionMenu.js";
import { SuggestionMenuEmptyItem } from "./suggestionMenu/SuggestionMenuEmptyItem.js";
import { SuggestionMenuItem } from "./suggestionMenu/SuggestionMenuItem.js";
import { SuggestionMenuLabel } from "./suggestionMenu/SuggestionMenuLabel.js";
import { SuggestionMenuLoader } from "./suggestionMenu/SuggestionMenuLoader.js";
import { ExtendButton } from "./tableHandle/ExtendButton.js";
import { TableHandle } from "./tableHandle/TableHandle.js";
import { Toolbar } from "./toolbar/Toolbar.js";
import { ToolbarButton } from "./toolbar/ToolbarButton.js";
import { ToolbarSelect } from "./toolbar/ToolbarSelect.js";

export const components: Components = {
FormattingToolbar: {
Root: Toolbar,
Button: ToolbarButton,
Select: ToolbarSelect,
},
FilePanel: {
Root: Panel,
Button: PanelButton,
FileInput: PanelFileInput,
TabPanel: PanelTab,
TextInput: PanelTextInput,
},
GridSuggestionMenu: {
Root: GridSuggestionMenu,
Item: GridSuggestionMenuItem,
EmptyItem: GridSuggestionMenuEmptyItem,
Loader: GridSuggestionMenuLoader,
},
LinkToolbar: {
Root: Toolbar,
Button: ToolbarButton,
},
SideMenu: {
Root: SideMenu,
Button: SideMenuButton,
},
SuggestionMenu: {
Root: SuggestionMenu,
Item: SuggestionMenuItem,
EmptyItem: SuggestionMenuEmptyItem,
Label: SuggestionMenuLabel,
Loader: SuggestionMenuLoader,
},
TableHandle: {
Root: TableHandle,
ExtendButton: ExtendButton,
},
Generic: {
Toolbar: {
Root: Toolbar,
Button: ToolbarButton,
},
Form: {
Root: Form,
TextInput: TextInput,
},
Menu: {
Root: Menu,
Trigger: MenuTrigger,
Dropdown: MenuDropdown,
Divider: MenuDivider,
Label: MenuLabel,
Item: MenuItem,
},
Popover: {
Root: Popover,
Trigger: PopoverTrigger,
Content: PopoverContent,
},
},
};
125 changes: 2 additions & 123 deletions packages/ariakit/src/index.tsx
Original file line number Diff line number Diff line change
@@ -1,125 +1,4 @@
import {
BlockSchema,
InlineContentSchema,
mergeCSSClasses,
StyleSchema,
} from "@blocknote/core";
import {
BlockNoteViewProps,
BlockNoteViewRaw,
Components,
ComponentsContext,
} from "@blocknote/react";

import { Form } from "./input/Form.js";
import { TextInput } from "./input/TextInput.js";
import {
Menu,
MenuDivider,
MenuDropdown,
MenuItem,
MenuLabel,
MenuTrigger,
} from "./menu/Menu.js";
import { Panel } from "./panel/Panel.js";
import { PanelButton } from "./panel/PanelButton.js";
import { PanelFileInput } from "./panel/PanelFileInput.js";
import { PanelTab } from "./panel/PanelTab.js";
import { PanelTextInput } from "./panel/PanelTextInput.js";
import { Popover, PopoverContent, PopoverTrigger } from "./popover/Popover.js";
import { SideMenu } from "./sideMenu/SideMenu.js";
import { SideMenuButton } from "./sideMenu/SideMenuButton.js";
import { GridSuggestionMenu } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenu.js";
import { GridSuggestionMenuEmptyItem } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenuEmptyItem.js";
import { GridSuggestionMenuItem } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenuItem.js";
import { GridSuggestionMenuLoader } from "./suggestionMenu/gridSuggestionMenu/GridSuggestionMenuLoader.js";
import { SuggestionMenu } from "./suggestionMenu/SuggestionMenu.js";
import { SuggestionMenuEmptyItem } from "./suggestionMenu/SuggestionMenuEmptyItem.js";
import { SuggestionMenuItem } from "./suggestionMenu/SuggestionMenuItem.js";
import { SuggestionMenuLabel } from "./suggestionMenu/SuggestionMenuLabel.js";
import { SuggestionMenuLoader } from "./suggestionMenu/SuggestionMenuLoader.js";
import { ExtendButton } from "./tableHandle/ExtendButton.js";
import { TableHandle } from "./tableHandle/TableHandle.js";
import { Toolbar } from "./toolbar/Toolbar.js";
import { ToolbarButton } from "./toolbar/ToolbarButton.js";
import { ToolbarSelect } from "./toolbar/ToolbarSelect.js";

import "./style.css";

export const components: Components = {
FormattingToolbar: {
Root: Toolbar,
Button: ToolbarButton,
Select: ToolbarSelect,
},
FilePanel: {
Root: Panel,
Button: PanelButton,
FileInput: PanelFileInput,
TabPanel: PanelTab,
TextInput: PanelTextInput,
},
GridSuggestionMenu: {
Root: GridSuggestionMenu,
Item: GridSuggestionMenuItem,
EmptyItem: GridSuggestionMenuEmptyItem,
Loader: GridSuggestionMenuLoader,
},
LinkToolbar: {
Root: Toolbar,
Button: ToolbarButton,
},
SideMenu: {
Root: SideMenu,
Button: SideMenuButton,
},
SuggestionMenu: {
Root: SuggestionMenu,
Item: SuggestionMenuItem,
EmptyItem: SuggestionMenuEmptyItem,
Label: SuggestionMenuLabel,
Loader: SuggestionMenuLoader,
},
TableHandle: {
Root: TableHandle,
ExtendButton: ExtendButton,
},
Generic: {
Form: {
Root: Form,
TextInput: TextInput,
},
Menu: {
Root: Menu,
Trigger: MenuTrigger,
Dropdown: MenuDropdown,
Divider: MenuDivider,
Label: MenuLabel,
Item: MenuItem,
},
Popover: {
Root: Popover,
Trigger: PopoverTrigger,
Content: PopoverContent,
},
},
};

export const BlockNoteView = <
BSchema extends BlockSchema,
ISchema extends InlineContentSchema,
SSchema extends StyleSchema
>(
props: BlockNoteViewProps<BSchema, ISchema, SSchema>
) => {
const { className, ...rest } = props;

return (
<ComponentsContext.Provider value={components}>
<BlockNoteViewRaw
className={mergeCSSClasses("bn-ariakit", className || "")}
{...rest}
/>
</ComponentsContext.Provider>
);
};
export * from "./BlockNoteView.js";
export * from "./components.js";
97 changes: 97 additions & 0 deletions packages/mantine/src/BlockNoteView.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
import {
BlockSchema,
InlineContentSchema,
mergeCSSClasses,
StyleSchema,
} from "@blocknote/core";
import {
BlockNoteViewProps,
BlockNoteViewRaw,
ComponentsContext,
useBlockNoteContext,
usePrefersColorScheme,
} from "@blocknote/react";
import { MantineProvider } from "@mantine/core";
import { useCallback } from "react";
import {
applyBlockNoteCSSVariablesFromTheme,
removeBlockNoteCSSVariables,
Theme,
} from "./BlockNoteTheme.js";
import { components } from "./components.js";
import "./style.css";

const mantineTheme = {
// Removes button press effect
activeClassName: "",
};

export const BlockNoteView = <
BSchema extends BlockSchema,
ISchema extends InlineContentSchema,
SSchema extends StyleSchema
>(
props: Omit<BlockNoteViewProps<BSchema, ISchema, SSchema>, "theme"> & {
theme?:
| "light"
| "dark"
| Theme
| {
light: Theme;
dark: Theme;
};
}
) => {
const { className, theme, ...rest } = props;

const existingContext = useBlockNoteContext();
const systemColorScheme = usePrefersColorScheme();
const defaultColorScheme =
existingContext?.colorSchemePreference || systemColorScheme;

const ref = useCallback(
(node: HTMLDivElement | null) => {
if (!node) {
// todo: clean variables?
return;
}

removeBlockNoteCSSVariables(node);

if (typeof theme === "object") {
if ("light" in theme && "dark" in theme) {
applyBlockNoteCSSVariablesFromTheme(
theme[defaultColorScheme === "dark" ? "dark" : "light"],
node
);
return;
}

applyBlockNoteCSSVariablesFromTheme(theme, node);
return;
}
},
[defaultColorScheme, theme]
);

return (
<ComponentsContext.Provider value={components}>
{/* `cssVariablesSelector` scopes Mantine CSS variables to only the editor, */}
{/* as proposed here: https://github.com/orgs/mantinedev/discussions/5685 */}
<MantineProvider
theme={mantineTheme}
cssVariablesSelector=".bn-mantine"
// This gets the element to set `data-mantine-color-scheme` on. Since we
// don't need this attribute (we use our own theming API), we return
// undefined here.
getRootElement={() => undefined}>
<BlockNoteViewRaw
className={mergeCSSClasses("bn-mantine", className || "")}
theme={typeof theme === "object" ? undefined : theme}
{...rest}
ref={ref}
/>
</MantineProvider>
</ComponentsContext.Provider>
);
};
Loading
Loading