May 5, 2021
By Mitch MacKenzie & DJ Walker
Inline editing removes many usability hurdles that content editors face when working with traditionally decoupled CMS forms. Editors get to see their content changes immediately in the context of their actual website. But developers have been sharing the trade-offs associated with inline editing's current implementation with us.
We're continuing to learn from our development community and looking at better ways of integrating the superpowers that inline editing bestows.
And let's not forget about sidebar editing in this discussion! The attractiveness of inline editing often overshadows the flexible setup and usability wins that we get with sidebar editing. We recommend starting with sidebar editing to get up and running quickly.
Let's take a look at a simple inline editing scenario where we make the title of a page editable.
We wrap our page with the TinaCMS
InlineForm component so that our child components behave like a form. We can edit the title value by using the
InlineText component to inject a text input.
We gain a lot of control as developers with this approach. The inline editing components live with your layout components and behave pretty much as you would expect them to.
But there are a few trade-offs to this approach:
InlineTextadd markup and behaviour that can interfere with your desired layout and styling. You now have an
inputelement and wrapping
divswhere you'd typically just render text.
Another side effect of having inline editing coupled to your components is that you're now bringing TinaCMS with your components, everywhere.
We could try conditionally adding the inline editing components, but it's clear that the logic needed to include inline editing is now coupled to our page and components. It's now more challenging to maintain, share, or re-use those components.
The usability benefits of inline editing could outweigh these concerns depending on your use case. But we're searching for solutions with fewer trade-offs.
useFieldRef is the first part of an experimental new API for creating a ref-based inline editing experience with Tina. With
useFieldRef, inline editing components are defined in the form configuration, and you assign a ref to the component in your layout that the field should attach to.
Inline fields created in this fashion are absolutely positioned on top of the referenced component and conform to its dimensions. Ref-based inline editing makes it possible for the field to appear as if it's replacing the layout component in the DOM without altering the markup.
In contrast to our first example, we define an
inlineComponent key in our form configuration object. We are adding an inline editing component in the same manner as setting up sidebar editing!
We then call
useFieldRef to acquire the ref that will be attached to our title element.
The drawback of this approach is that you need to duplicate aspects of your website's components between the normal view-only routes and the routes where TinaCMS is included.
We are making it clear in our documentation and guides that the original inline editing approach and Ref-Based inline editing are still experimental.
Sidebar editing avoids most of the friction of integrating inline editing and provides many of the same usability wins. Moreover Tina Cloud auto-generates sidebar forms based on your content's schema and represents our current recommended best practice.
Please do share ideas, constraints or design patterns on how to bring a better visual editing experience to the Jamstack without sacrificing the codebase, it's a discussion we need to have with the community.
Last Edited: May 5, 2021