Skip to main content

Sliding Container

shadow

The wje-sliding-container page was auto-generated to keep API documentation coverage in sync with the current component set. Detailed usage and best-practice guidance will be expanded in the next content phase.

When to use

Use wje-sliding-container to compose stable page structure with clear visual and semantic hierarchy.

When not to use

Do not use layout components to handle business logic or application orchestration.

Accessibility

Preserve document semantics (header, main, aside, footer) and logical tab/focus order.

Best Practices

  • Define mobile/desktop breakpoints first, then refine visual details.
  • Prefer spacing tokens over ad-hoc margin/padding overrides.
  • Test keyboard and screen reader behavior for overflow scenarios.

Attributes and Properties

addToHeight

DescriptionSets the value of the 'add-to-height' attribute. This attribute is used to modify or adjust the height dynamically.
Attributeadd-to-height
Typestring
Default0

animationDuration

DescriptionGets the animation duration for an element. It retrieves the value of the 'animation-duration' attribute if present; otherwise, it defaults to '500'.
Attributeanimation-duration
Typestring
Default500

animationEasing

DescriptionSets the easing function for the animation.
Attributeanimation-easing
Typestring
Defaultlinear

direction

DescriptionRetrieves the direction attribute of the instance. If the direction attribute is not set, it defaults to 'right'.
Attributedirection
Typestring
Defaultright

hasOpacity

DescriptionDetermines if the element has an 'has-opacity' attribute.
Attributehas-opacity
Typeboolean
Defaultfalse

maxHeight

DescriptionSets the maximum height for the element.
Attributemax-height
Typestring
Defaultauto

maxWidth

DescriptionSets the maximum width of an element by updating the 'max-width' attribute.
Attributemax-width
Typestring
Defaultauto

removeChildAfterClose

DescriptionSets the value of the remove-child-after-close attribute. This attribute determines if a child element should be removed after a close operation.
Attributeremove-child-after-close
Typeboolean|string
Defaultfalse

screenBreakPoint

DescriptionRetrieves the value of the 'screen-break-point' attribute.
Attributescreen-break-point
Typestring
Default-

trigger

DescriptionRetrieves the value of the 'trigger' attribute. If the attribute is not set, it defaults to 'sliding-container'.
Attributetrigger
Typestring
Defaultsliding-container

variant

DescriptionSets the 'variant' attribute to the specified value.
Attributevariant
Typestring
Defaultin-place

Events

NameDescription
wje-sliding-container:beforeOpenEmitted when the component opens.
wje-sliding-container:openEmitted when the component is opened.
wje-sliding-container:beforeCloseEmitted when the component closes.
wje-sliding-container:afterCloseEmitted when the component closes.

Methods

open

DescriptionOpens the sliding container by performing necessary preparatory and transitional operations.
Signature(e: Event) => Promise<void>

close

DescriptionCloses the sliding container and performs associated operations such as animations and event dispatches.
Signature(e: Event) => Promise<void>

toggle

DescriptionToggles the state between open and closed.
Signature(e: Event) => Promise<void>

CSS Shadow Parts

NameDescription
``Styles the element.

CSS Custom Properties

No CSS custom properties available for this component.

Slots

NameDescription
defaultThe default slot for the SlidingContainer.