Options
All
  • Public
  • Public/Protected
  • All
Menu

Collapsible

Example

<section id="collapse">
  <div>
    <header>title 1</header>
    <article>content 1</article>
  </div>
  <div>
    <header>title 2</header>
    <article>content 2</article>
  </div>
  <div>
    <header>title 3</header>
    <article>content 3</article>
  </div>
</section>
const collapsible = new Collapsible(
  document.getElementById('collapse')
);

collapsible.on('collapse', ({title, content, index}) => {});
collapsible.on('expand', ({title, content, index}) => {});

Hierarchy

  • EventEmitter
    • Collapsible

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

host

host: HTMLElement

container element

Methods

collapse

  • collapse(index: number | number[], direct?: boolean): void | Promise<void>
  • Collapse item

    Parameters

    • index: number | number[]
    • Optional direct: boolean

      collapse directly without animation

    Returns void | Promise<void>

    return promise if animation is enabled

destroy

  • destroy(): void

expand

  • expand(index: number | number[], direct?: boolean): void | Promise<void>
  • Expand item

    Parameters

    • index: number | number[]
    • Optional direct: boolean

      expand directly without animation

    Returns void | Promise<void>

    return promise if animation is enabled

off

  • off(type: string, handler: function): void
  • Remove an event handler for the given type.

    Parameters

    • type: string

      Type of event to unregister handler from, or "*"

    • handler: function

      Handler function to remove

        • (event?: any): void
        • Parameters

          • Optional event: any

          Returns void

    Returns void

on

  • on(type: string, handler: function): void
  • Register an event handler for the given type.

    Parameters

    • type: string

      Type of event to listen for, or "*" for all events

    • handler: function

      Function to call in response to given event

        • (event?: any): void
        • Parameters

          • Optional event: any

          Returns void

    Returns void

refresh

  • refresh(reset: boolean): void
  • Refresh

    Parameters

    • reset: boolean

      Expand the specified items with initial configuration

    Returns void

toggle

  • toggle(index: number | number[], direct?: boolean): void | Promise<void>
  • Toggle item

    Parameters

    • index: number | number[]
    • Optional direct: boolean

      toggle directly without transition

    Returns void | Promise<void>

    return promise if animation is enabled

Static config

Generated using TypeDoc