Editor Preferences and User Settings
The Hyvä CMS Liveview Editor remembers how each admin user likes to work. Editor preferences, custom keyboard shortcuts, and favourite components are saved per admin user in the database, so they follow the user between sessions and machines. A separate set of shared defaults lets administrators standardize behavior for everyone.
There are three distinct setting systems, and they intentionally live in different places:
- Editor preferences and keyboard shortcuts are personal. They are saved per admin user.
- Favourite components are personal. They are saved per admin user.
- Default component classes are shared. They are stored in Magento system configuration and apply to all admin users.
Open the settings with Editor Preferences from the Hyvä menu, or press Mod + , (Cmd + , on macOS, Ctrl + , on Windows and Linux).
What changed since Hyvä CMS 1.2.0
Editor preferences are available in earlier versions. Hyvä CMS 1.2.0 added favourite components and customizable keyboard shortcuts, and moved preferences from browser local storage to per-user database storage.
The first time you open the editor after upgrading, any preferences previously saved in local storage are migrated to the database automatically.
Editor Preferences
The General tab holds personal toggles that change how the editor behaves for your user only. These preferences are saved to the database per admin user.
| Preference | What it does | Default |
|---|---|---|
| Update Hyvä Styles on Edit | Generate Tailwind CSS in real time while editing, instead of only when you save. | Off |
| Sidebar on Left | Show the component sidebar on the left of the editor instead of the right. | Off |
| Enable Context Editing | Show a quick-action dot when you hover a component in the preview, for editing without opening the sidebar. | On |
| Open Component Editor on Add | Automatically open the edit panel when you add a new component. | Off |
| Show Content Preview in Tree | Show a snippet of each component's text content beside its entry in the component tree. | On |
| Confirm Before Publishing | Show a confirmation dialog before publishing changes. | Off |
Update Hyvä Styles on Edit needs Tailwind JIT enabled
The Update Hyvä Styles on Edit preference only applies when Tailwind CSS JIT is enabled for the current content in its content settings. When the preference is off, styles are compiled when you save. When it is on, they compile in real time as you edit. Real-time compilation is heavier, so leave it off unless you are actively styling.
Keyboard Shortcuts
The Keybindings tab lets each user remap the editor's keyboard shortcuts. Keybindings are saved per admin user alongside the other editor preferences.
See Keyboard Shortcuts for the full list of default shortcuts and how to customize them.
Favourite Components
Content editors can star the components they use most. Starred components appear in a Favourites tab at the top of the component picker, so frequently used components are always one click away.
- Click the star icon on any component in the picker to add or remove it from your favourites.
- The Favourites tab only appears once you have starred at least one component.
- Favourites are saved per admin user.
Default Component Classes
Default component classes pre-populate the CSS Classes field whenever a matching component is added to the canvas. For example, you can configure the text component to start with the prose class, so editors get Tailwind Typography styling without having to type it.
Unlike editor preferences and favourites, default component classes are shared across all admin users. They are managed in the Shared tab of Editor Preferences, and stored in Magento system configuration.
Admin path:
Stores > Configuration > Hyvä Commerce > Hyvä CMS > Editor Settings > Default Component Classes
Each row maps a component to the class string applied when that component is added. Hyvä CMS ships with a default mapping of the text component to prose.
A better way than asking editors to add classes
Default component classes keep content consistent without putting CSS in front of merchants. Combined with well-designed component fields and variants, they help editors get an on-brand result without ever touching a class name. See Working with Components for the design-system approach.
For Developers
User settings are stored per admin user and exposed through a JavaScript API and Alpine stores, so third-party modules can read, write, and extend them. See User Settings API.