表單文字元件(v1) form-text-component-v

核心元件表單文字元件可讓您輸入表單文字以供提交。

使用情況 usage

表單文字元件允許提交不同型別的文字,並打算與表單容器元件搭配使用。

文字驗證型別、標籤和說明訊息可由內容編輯者在設定對話方塊中定義。

版本和相容性 version-and-compatibility

本檔案說明表單文字元件v1,其最初隨附於AEM 6.3的核心元件1.0.0版引入。

下表列出表單文字元件v1的相容性。

AEM 版本
表單文字元件v1
6.3
相容
6.4
相容
CAUTION
本檔案說明表單文字元件v1。
如需目前版本的表單文字元件的詳細資訊,請參閱表單文字元件檔案。

範例元件輸出 sample-component-output

以下是從We.Retail中取得的範例。

螢幕擷圖 screenshot

HTML html

<div class="cmp cmp-form aem-GridColumn aem-GridColumn--default--12">
 <form method="POST" action="/content/we-retail/us/en/experience.html" id="new_form" name="new_form" enctype="multipart/form-data" class="aem-Grid aem-Grid--12 aem-Grid--default--12 ">
     <input type="hidden" name=":formstart" value="/content/we-retail/us/en/experience/jcr:content/root/responsivegrid/container">
     <div class="cmp cmp-form-field aem-GridColumn aem-GridColumn--default--12">
   <div class="form-group">
       <label for="form-text-978484744">How many pieces of toast would you like?</label>
          <input type="number" id="form-text-978484744" name="pieces">
   </div>
  </div>
 </form>
</div>

JSON json

"container": {
              "columnClassNames": "aem-GridColumn aem-GridColumn--default--12",
              "columnCount": 12,
              "gridClassNames": "aem-Grid aem-Grid--12 aem-Grid--default--12",
              ":items": {
                "text": {
                  "columnClassNames": "aem-GridColumn aem-GridColumn--default--12",
                  ":type": "weretail/components/form/text",
                  "name": "piecesOfToast",
                  "jcr:title": "How many pieces of toast would you like?",
                  "type": "number",
                  "rows": "2"
                }
              },
              ":itemsOrder": [
                "text"
              ],
              ":type": "weretail/components/form/container"
            }
NOTE
從核心元件匯出JSON需要版本1.1.0的核心元件。 如需詳細資訊,請參閱核心元件v1🔗的相容性資訊。

設定對話方塊 configure-dialog

「設定」對話方塊可讓內容作者定義要輸入的文字型別,以及預設值和標籤。

主要 main

  • 限制 — 要輸入且將接受驗證的文字型別

    • 文字
    • 文字區域
    • 電子郵件
    • 電話
    • 日期
    • 數字
    • 密碼
  • 文字行 — 要在文字區域中顯示的行數(僅當​ 條件約束 ​設定為​ 文字區域 ​時才會顯示)

  • 標籤 — 將為欄位顯示的標籤

  • 隱藏標籤以避免顯示 — 標籤僅需用於協助工具目的且不會提供欄位任何額外視覺資訊時需要

  • 元素名稱 — 與表單資料共同提交的欄位名稱

  • — 預設值(已預先填入欄位中)

關於 about

  • 說明訊息 — 使用者可在欄位中輸入的內容提示
  • 將說明訊息顯示為預留位置 — 當表單輸入為空白且焦點不在其上時,在表單輸入中顯示說明訊息

限制 constraints

  • 限制訊息

    • 如果值沒有驗證選取的類型,提交表單時訊息會顯示為工具提示
    • 未針對​ 文字 ​和​ 文字區域 ​限制型別顯示
  • 必要 — 如果選取,使用者必須在提交表單前填入值

  • 設為唯讀 — 如果選取,使用者無法修改欄位的值

設計對話方塊 design-dialog

表單文字元件沒有「設計」對話方塊。

技術細節 technical-details

在GitHub🔗上可找到有關表單文字元件的最新技術檔案。

您可以從GitHub下載整個核心元件專案。

核心元件開發人員檔案中可找到有關開發核心元件的進一步詳細資料。

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c