Class ToggleOverlayOptions

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the toggle overlay options.

[ExcludeFromCodeCoverage]
[SuppressMessage("Minor Code Smell", "S2325:Methods and properties that don't access instance data should be static", Justification = "Stubs for transpilation.")]
public class ToggleOverlayOptions

Inheritance

object

ToggleOverlayOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ToggleOverlayOptions(string)

Initializes a new instance of the ToggleOverlayOptions class.

public ToggleOverlayOptions(string overlayId)

Parameters

overlayId string

Overlay id.

Properties

OverlayId

Gets the overlay identifier.

public string OverlayId { get; }

Property Value

string

State

Gets the forced state.

public object? State { get; }

Property Value

object

Target

Gets the target element to which the overlay will use.

public object? Target { get; }

Property Value

object

Methods

WithState(bool?)

Sets the forced state of the overlay. By default, the overlay will open if it is closed and close if it is opened.

public ToggleOverlayOptions WithState(bool? state)

Parameters

state bool?

The state to set. True for open, false for closed, or null for default behavior.

Returns

ToggleOverlayOptions

Options.

WithTarget(object?)

Sets the target element.

public ToggleOverlayOptions WithTarget(object? target)

Parameters

target object

Target.

Returns

ToggleOverlayOptions

Options.