Action Visibility

Controlling the visibility of actions in Umbraco UI Builder, the backoffice UI builder for Umbraco.

By default actions are not visible in the UI and you must expressly define when and where an action should display. This can be achived in two ways, either on the action definition itself or at the point of registration on the collections config.
Controlling the default action visibility
To define the default visbility of an action at the action level you can do this by overriding the IsVisible method of the Action<> base class.
// Example
public class MyAction : Action<ActionResult>
{
    ...
    public override bool IsVisible(ActionVisibilityContext ctx)
    {
        return ctx.ActionType == ActionType.Bulk 
            || ctx.ActionType == ActionType.Row;
    }
    ...
}
The IsVisible method is passed a ActionVisibilityContext which you should use to decide whether the action should display, returning true if it should, or false if it should not. For more information check the Action visibility context.
Overriding an actions visibility
Overriding an actions visibility is controlled via the collections configuration.
AddAction<TMenuActionType>(Lambda actionConfig = null) : CollectionConfigBuilder<TEntityType>
Adds an action of the given type to the collection with the given visibility.
// Example
collectionConfig.AddAction<ExportMenuAction>(actionConfig => actionConfig
    .SetVisibility(x => x.ActionType == ActionType.Bulk 
        || x.ActionType == ActionType.Row)
);
AddAction(Type actionType, Lambda actionConfig = null) : CollectionConfigBuilder<TEntityType>
Adds an action of the given type to the collection with the given visibility.
// Example
collectionConfig.AddAction(typeof(ExportMenuAction), actionConfig => actionConfig
    .SetVisibility(x => x.ActionType == ActionType.Bulk 
        || x.ActionType == ActionType.Row)
);
AddAction(IAction action, Lambda actionConfig = null) : CollectionConfigBuilder<TEntityType>
Adds the given action to the collection with the given visibility.
// Example
collectionConfig.AddAction(action, actionConfig => actionConfig
    .SetVisibility(x => x.ActionType == ActionType.Bulk 
        || x.ActionType == ActionType.Row)
);
Action visibility context
When controlling the visibility of an action you will be given a ActionVisibilityContext object from which you can decide whether to show the action or not. The visibility context contains two key pieces of information on which you can base this decision.
ActionType
The action type property is an enum property that define which area of the UI it is that wishes to access this action. Enabling an action to display for a given action type will determine where an action is displayed.
ContainerMenu
The ContainerMenu action type determines that the action will be displayed in both the tree of the collection and its list view actions menu.
Container Menu
EntityMenu
The EntityMenu action type determines that the action will be displayed in the actions menu of a collection editor UI.
Entity Menu
Bulk
The Bulk action type determines that the action will be displayed in the collection list view bulk actions menu.
Bulk Actions
Row
The Row action type determines that the action will be displayed in the collection list view action row menu.
Row Actions
Save
The Save action type determines that the action will be displayed as a sub button in an entity editors save button. All Save action types trigger a save before the action is executed and so to convey this, all Save action type button labels are prefixed Save & [Action Name]
Save Actions
UserGroups
The user groups collection contains a list of Umbraco IReadOnlyUserGroup objects for the current logged-in backoffice user. This allows you to control the visibility of actions for given user group members.

Last modified 1mo ago