feat: Toggle blocks #1707
feat: Toggle blocks #1707
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@blocknote/ariakit
@blocknote/code-block
@blocknote/core
@blocknote/mantine
@blocknote/react
@blocknote/server-util
@blocknote/shadcn
@blocknote/xl-ai
@blocknote/xl-docx-exporter
@blocknote/xl-multi-column
@blocknote/xl-odt-exporter
@blocknote/xl-pdf-exporter
commit: |
| export const ToggleHeading = createBlockSpec( | ||
| { | ||
| ...headingConfig, | ||
| type: "toggleHeading", | ||
| }, | ||
| { | ||
| ...headingImplementation, | ||
| render: (block, editor) => | ||
| createToggleWrapper( | ||
| block, | ||
| editor, | ||
| headingImplementation.render(block, editor), | ||
| ), | ||
| }, | ||
| ); |
There was a problem hiding this comment.
This is fantastic, composability!
There was a problem hiding this comment.
Now, this is creating a new block type, can we instead just "wrap over" heading, and if it has a prop isToggleable it switches it's render implementation from the default, into using this toggle wrapper?
So that there is only one heading implementation.
There was a problem hiding this comment.
Should I also revert the heading block to using createStronglyTypedTiptapNode? Since the keyboard shortcuts and input rules won't work if we stick with createBlockSpec. Or do you wanna see how it looks using the createBlockSpec first?
There was a problem hiding this comment.
For now, it is more important to see that the pattern can work before being caught up in those sort of details.
Once we can see that it works for headings, we can see if we can do it for something like list items
There was a problem hiding this comment.
Makes sense, updated the code👍
There was a problem hiding this comment.
Great, this looks about right. Ideally it'd be "around" the heading component, but that is minor and fixable.
To explain more, like this you made this:
function Heading(props){
function renderHeading(){}
return props.isToggleable ? <Toggle>{renderHeading()}</Toggle> : renderHeading()
}
blocks: { heading: Heading }Where I'd like something more like this:
function Heading() {
return renderHeading()
}
const WrapWithToggle=(component) => props => {
return props.isToggleable ? <Toggle>{component}</Toggle> : component
}
blocks: { heading: WrapWithToggle(heading) }There was a problem hiding this comment.
Now that we've validated this approach, I do think you have the right idea with making this a strongly typed tiptap node to keep all previous functionality.
There was a problem hiding this comment.
Implemented your suggestions, think it looks pretty decent. There are 2 things that aren't super nice though:
- Headings now always need to include a node view, even if they're not togglable.
- Because
createStronglyTypedTiptapNodeworks on the TipTap API level whilecreateToggleWrapperworks on the BlockNote API level, we have to convert from a node to a block in the node view and do some slightly weird stuff there.
How much of a concern are those 2?
There was a problem hiding this comment.
- should be fine, node views are essentially "ejecting" from normal rendering but shouldn't be different (if in pure JS not react)
- Yea, so the ideal here is to build everything in terms of the blocknote API instead in the future, just don't wanna invest into that at the moment. May be worth extracting into something common, but not necessary for the moment either.
So, I think this is good from here. 🚦 green light to implement the lists & other ones, it seems like a sound approach for the moment.
There was a problem hiding this comment.
Nice! Still need to dive a bit deeper in the code but in general looks great.
Let's make the UX a bit more polished. When comparing with other products (e.g. Notion), this catches my attention:
- let's make the arrow similar to notion (the rounded caret doesn't work well with the font), and same size regardless of heading size
- Can you pay extra attention to alignment and margins? These are some of the most impactful design concepts. For example, the nested content should be vertically aligned with the parent content (if it helps, remove the vertical border on the left)
- empty toggle list should have a placeholder "Toggle" (same as Notion)
- dragging a collapsed toggle to a different position expands it's state
- Nice to have: dropping blocks in an empty toggle
Others:
- Toggle heading doesn't appear in formatting toolbar dropdown
- We need to design an API of where to store "collapsed state" for the current user
- Typing in an empty toggle collapses the arrow (but does show the children placeholder)
- key down in an empty toggle doesn't work. In general, make sure to test keyboard handling
- nice to have (but probably not trivial?): cmd+shift+arrow skip over collapsed blocks
| @@ -32,6 +32,11 @@ export default function App() { | |||
| type: "heading", | |||
| content: "Heading", | |||
| }, | |||
| { | |||
| type: "heading", | |||
| props: { isTogglable: true }, | |||
There was a problem hiding this comment.
let's use isToggleable to be more inline with notion (https://developers.notion.com/reference/block#toggle-blocks)
| @@ -0,0 +1,8 @@ | |||
| # Togglable Blocks | |||
|
|
|||
| This example shows how to create blocks with a toggle button to show/hide their children, like with the default toggle heading and list item blocks. This is done using the use the `ToggleWrapper` component from `@blocknote/react`. | |||
There was a problem hiding this comment.
let's make explicit (both in the example name and description) that this is about custom blocks
| quote: { | ||
| title: "Quote", | ||
| subtext: "Quote or excerpt", | ||
| aliases: ["quotation", "blockquote", "bq"], | ||
| group: "Basic blocks", | ||
| }, | ||
| toggle_list: { | ||
| title: "Toggle List", | ||
| subtext: "List with hidable sub-items", |
Toggle wrapper element/component
This PR adds a new component,
ToggleWrapper, as well as a vanilla HTML element implementation of it,createToggleWrapper. These can be used to wrap existing blocks, or create new ones and allow the user to toggle showing/hiding their children. The toggle wrapper renders a button to the left of the block to show/hide the children. Additionally, if children are shown but none exist, a button is rendered to prompt the user to add a block. Because the toggled state is only in the view, toggling the visibility of children only happens client-side when using collaboration.Schema changes
This PR also adds toggle headings and toggle list items to the default editor schema. The toggle headings are implemented by adding an
isTogglableprop, and rendering the block in a toggle wrapper when this is set totrue. The toggle list item is a new, separate block, which always renders a paragraph in a toggle wrapper. Like the other list items though, hitting Enter in one creates a new block of the same type, which is why I made it a separate block rather than addingisTogglableto the existing paragraph or list item blocks. Additionally, the block is exported differently to formats like docx, as the content gets prepended with a ">".TODO
Currently some
xl-aitests are failing, and these have been temporarily disabled.Closes #196
Closes #549
Closes #910