arozos/web/NotepadA/utils/tocasdoc/modules/accordion.yml

Title      : 手風琴
Description: 叭啦叭叭叭叭，喔不好意思那是小喇叭。

Settings:

  Properties:

    - Key        : exclusive
      Default    : true
      Description: 是否僅允許單個手風琴只有一個分頁能被打開。
      Type       : Boolean

    - Key        : collapsible
      Default    : true
      Description: 展開的手風琴是否可以被關閉。
      Type       : Boolean

    - Key        : closeNested
      Default    : true
      Description: 當手風琴被關閉時，是否一同閉合子手風琴。
      Type       : Boolean

  Callbacks:

    - Name       : onOpening
      Description: 當手風琴正在展開時所會呼叫的函式。
      Context    :
        Description: 正在展開的手風琴項目內容元素。
        Type       : HTMLElement

      Arguments  :
        - Name       : index
          Description: 欲開啟的手風琴項目索引編號。
          Type       : Integer

    - Name       : onOpen
      Description: 當手風琴展開時所會呼叫的函式。
      Context    :
        Description: 展開的手風琴項目內容元素。
        Type       : HTMLElement

    - Name       : onClosing
      Description: 當手風琴正在關閉時所會呼叫的函式。
      Context    :
        Description: 正在關閉的手風琴項目內容元素。
        Type       : HTMLElement

    - Name       : onClose
      Description: 當手風琴關閉時所會呼叫的函式。
      Context    :
        Description: 關閉的手風琴項目內容元素。
        Type       : HTMLElement

    - Name       : onChange
      Description: 當手風琴被開、關時所會呼叫的函式。
      Context    :
        Description: 開、關的手風琴項目內容元素。
        Type       : HTMLElement

Usages:

  Examples:

    #- Title      : 種類
    #  Description: 在這裡瀏覽手風琴的種類。
    #  Sections   :
    #  - Title      : 初始化
    #    Description: 初始化一個最基本的手風琴元素。
    #    Since      : 3.0.0
    #    HTML       : |
    #      <details class="ts [[accordion]]" open>
    #          <summary>
    #              <i class="dropdown {{icon}}"></i>
    #              什麼是夏希？
    #          </summary>
    #          <div class="content">
    #              <p>夏希是一個基於 PHP 的時間類別，用以取得現在的時間，或者是數天後的現在時刻。</p>
    #          </div>
    #      </details>
    #    JavaScript: |
    #      ts('.ts.accordion').accordion()
    #    AutoExecute: false
    #    Executable: true

  Behaviors:

    - Name       : Open
      Description: 開啟指定的手風琴項目。
      Arguments  :
        - Name       : index
          Required   : true
          Description: 欲開啟的手風琴項目索引編號。
          Type       : Integer
      Return:
        Type       : Module
        Description: 模組鏈本體。

    - Name       : Close
      Description: 關閉指定的手風琴項目。
      Arguments  :
        - Name       : index
          Required   : true
          Description: 欲關閉的手風琴項目索引編號。
          Type       : Integer
      Return:
        Type       : Module
        Description: 模組鏈本體。

    - Name       : Toggle
      Description: 切換指定的手風琴項目，當該項目為開啟時會關閉，反之亦然。
      Arguments  :
        - Name       : index
          Required   : true
          Description: 欲切換的手風琴項目索引編號。
          Type       : Integer
      Return:
        Type       : Module
        Description: 模組鏈本體。

    - Name       : CloseChildren
      Description: 關閉指定手風琴項目底下的所有子手風琴項目。
      Arguments  :
        - Name       : index
          Required   : true
          Description: 欲關閉子手風琴的父手風琴項目索引編號。
          Type       : Integer
      Return:
        Type       : Module
        Description: 模組鏈本體。

    - Name       : CloseOthers
      Description: 關閉指定手風琴項目以外的其他項目。
      Arguments  :
        - Name       : index
          Required   : true
          Description: 關閉此索引編號以外的其他項目。
          Type       : Integer
      Return:
        Type       : Module
        Description: 模組鏈本體。

    - Name       : CloseAll
      Description: 關閉所有的手風琴項目。
      Return:
        Type       : Module
        Description: 模組鏈本體。

    - Name       : IsActive
      Description: 得知一個指定的手風琴項目是否處於開啟狀態。
      Return:
        Type       : Boolean
        Description: 是否為開啟狀態的布林值。

    - Name       : IsHidden
      Description: 得知一個指定的手風琴項目是否處於關閉狀態。
      Return:
        Type       : Boolean
        Description: 是否為關閉狀態的布林值。

Definitions:

  - Title      : 種類
    Description: 在這裡瀏覽手風琴的種類。
    Sections   :

      - Title      : 手風琴
        Description: 最基本的手風琴。
        Since      : 2.3.3
        HTML       : |
          <details class="ts [[accordion]]" open>
              <summary>
                  <i class="dropdown {{icon}}"></i>
                  什麼是夏希？
              </summary>
              <div class="content">
                  <p>夏希是一個基於 PHP 的時間類別，用以取得現在的時間，或者是數天後的現在時刻。</p>
              </div>
          </details>

  - Title      : 內容
    Description: 手風琴的內部構造不僅一種。
    Sections   :

      - Title      : 標題
        Description: 手風琴的標題，作為欲展開內容的大鋼。
        Since      : 2.3.3
        HTML       : |
          <details class="ts accordion">
              <[[summary]]>
                  <i class="dropdown {{icon}}"></i>
                  我是標題，我永遠不會被收縮。
              </[[summary]]>
          </details>

      - Title      : 內容
        Description: 擺放欲收縮和展開的內容容器。
        Since      : 2.3.3
        HTML       : |
          <details class="ts accordion" open>
              <summary>
                  <i class="dropdown {{icon}}"></i>
                  我是手風琴標題
              </summary>
              <div class="[[content]]">
                  <p>按下標題可以收縮或是展開我。</p>
              </div>
          </details>

  - Title      : 外觀
    Description: 手風琴的外觀可以有所不同。
    Sections   :

      - Title      : 反色
        Description: 手風琴可以是反色的。
        Since      : 2.3.3
        HTML       : |
          <div class="ts inverted {{segment}}">
              <details class="ts [[inverted]] accordion" open>
                  <summary>
                      <i class="dropdown {{icon}}"></i>
                      什麼是風紀委員？
                  </summary>
                  <div class="content">
                      <p>Jajjimento（ジャッジメント）中文涵意是風紀委員，這是用來驗證表單的 PHP 類別。</p>
                  </div>
              </details>
          </div>