@aurodesignsystem-dev/auro-formkit 0.0.0-pr1444.1 → 0.0.0-pr1445.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/components/checkbox/demo/api.min.js +1 -1
  2. package/components/checkbox/demo/index.min.js +1 -1
  3. package/components/checkbox/dist/index.js +1 -1
  4. package/components/checkbox/dist/registered.js +1 -1
  5. package/components/combobox/demo/api.min.js +3 -3
  6. package/components/combobox/demo/index.min.js +3 -3
  7. package/components/combobox/dist/index.js +3 -3
  8. package/components/combobox/dist/registered.js +3 -3
  9. package/components/counter/demo/api.min.js +2 -2
  10. package/components/counter/demo/index.min.js +2 -2
  11. package/components/counter/dist/index.js +2 -2
  12. package/components/counter/dist/registered.js +2 -2
  13. package/components/datepicker/demo/api.min.js +3 -3
  14. package/components/datepicker/demo/index.min.js +3 -3
  15. package/components/datepicker/dist/index.js +3 -3
  16. package/components/datepicker/dist/registered.js +3 -3
  17. package/components/dropdown/demo/api.min.js +1 -1
  18. package/components/dropdown/demo/index.min.js +1 -1
  19. package/components/dropdown/dist/index.js +1 -1
  20. package/components/dropdown/dist/registered.js +1 -1
  21. package/components/form/demo/api.min.js +13 -13
  22. package/components/form/demo/index.min.js +13 -13
  23. package/components/input/demo/api.min.js +1 -1
  24. package/components/input/demo/index.min.js +1 -1
  25. package/components/input/dist/index.js +1 -1
  26. package/components/input/dist/registered.js +1 -1
  27. package/components/radio/demo/api.min.js +1 -1
  28. package/components/radio/demo/index.min.js +1 -1
  29. package/components/radio/dist/index.js +1 -1
  30. package/components/radio/dist/registered.js +1 -1
  31. package/components/select/demo/api.min.js +2 -2
  32. package/components/select/demo/index.min.js +2 -2
  33. package/components/select/dist/index.js +2 -2
  34. package/components/select/dist/registered.js +2 -2
  35. package/custom-elements.json +1738 -1738
  36. package/package.json +1 -1
@@ -9261,52 +9261,92 @@
9261
9261
  },
9262
9262
  {
9263
9263
  "kind": "javascript-module",
9264
- "path": "components/helptext/src/auro-helptext.js",
9264
+ "path": "components/form/src/auro-form.js",
9265
9265
  "declarations": [
9266
9266
  {
9267
9267
  "kind": "class",
9268
- "description": "Displays help text or error messages within form elements - Internal Use Only.",
9269
- "name": "AuroHelpText",
9268
+ "description": "The `auro-form` element provides users a way to create and manage forms in a consistent manner.",
9269
+ "name": "AuroForm",
9270
+ "slots": [
9271
+ {
9272
+ "description": "The default slot for form elements.",
9273
+ "name": "default"
9274
+ }
9275
+ ],
9270
9276
  "members": [
9271
9277
  {
9272
- "kind": "method",
9273
- "name": "register",
9278
+ "kind": "field",
9279
+ "name": "formElementTags",
9274
9280
  "static": true,
9281
+ "readonly": true
9282
+ },
9283
+ {
9284
+ "kind": "method",
9285
+ "name": "_isElementTag",
9275
9286
  "parameters": [
9276
9287
  {
9277
- "name": "name",
9278
- "default": "\"auro-helptext\"",
9279
- "description": "The name of element that you want to register to.",
9280
- "optional": true,
9288
+ "name": "elementTag",
9289
+ "description": "The HTML tag name like `auro-datepicker`.",
9281
9290
  "type": {
9282
9291
  "text": "string"
9283
9292
  }
9293
+ },
9294
+ {
9295
+ "name": "element",
9296
+ "description": "The actual HTML element to compare.",
9297
+ "type": {
9298
+ "text": "HTMLElement"
9299
+ }
9284
9300
  }
9285
9301
  ],
9286
- "description": "This will register this element with the browser."
9302
+ "description": "Compare tag name with element to identify it (for API purposes).",
9303
+ "return": {
9304
+ "type": {
9305
+ "text": "boolean"
9306
+ }
9307
+ },
9308
+ "privacy": "private"
9287
9309
  },
9288
9310
  {
9289
9311
  "kind": "method",
9290
- "name": "handleSlotChange",
9312
+ "name": "_isInElementCollection",
9291
9313
  "parameters": [
9292
9314
  {
9293
- "name": "event"
9315
+ "name": "collection",
9316
+ "description": "The array to use for tag name search.",
9317
+ "type": {
9318
+ "text": "string[]"
9319
+ }
9320
+ },
9321
+ {
9322
+ "name": "element",
9323
+ "description": "The element to compare against the master list.",
9324
+ "type": {
9325
+ "text": "HTMLElement"
9326
+ }
9294
9327
  }
9295
- ]
9328
+ ],
9329
+ "description": "Shared code for determining if an element is something we care about (submit, form element, etc.).",
9330
+ "return": {
9331
+ "type": {
9332
+ "text": "boolean"
9333
+ }
9334
+ },
9335
+ "privacy": "private"
9296
9336
  },
9297
9337
  {
9298
9338
  "kind": "method",
9299
- "name": "checkSlotsForContent",
9339
+ "name": "isFormElement",
9300
9340
  "parameters": [
9301
9341
  {
9302
- "name": "nodes",
9303
- "description": "The list of nodes to check for content.",
9342
+ "name": "element",
9343
+ "description": "The element to check (attr or tag name).",
9304
9344
  "type": {
9305
- "text": "NodeList|Array"
9345
+ "text": "HTMLElement"
9306
9346
  }
9307
9347
  }
9308
9348
  ],
9309
- "description": "Checks if any of the provided nodes or their nested slot nodes contain non-empty text content.",
9349
+ "description": "Check if the tag name is a form element.",
9310
9350
  "return": {
9311
9351
  "type": {
9312
9352
  "text": "boolean"
@@ -9315,369 +9355,437 @@
9315
9355
  "privacy": "private"
9316
9356
  },
9317
9357
  {
9318
- "kind": "field",
9319
- "name": "error",
9320
- "privacy": "public",
9321
- "type": {
9322
- "text": "boolean"
9358
+ "kind": "method",
9359
+ "name": "_eventIsValidFormEvent",
9360
+ "parameters": [
9361
+ {
9362
+ "name": "event",
9363
+ "description": "The event to validate.",
9364
+ "type": {
9365
+ "text": "Event"
9366
+ }
9367
+ }
9368
+ ],
9369
+ "description": "Validates if an event is from a valid form element with a name.",
9370
+ "return": {
9371
+ "type": {
9372
+ "text": "boolean"
9373
+ }
9323
9374
  },
9324
- "description": "If declared, make font color red.",
9325
- "default": "false",
9326
- "attribute": "error",
9327
- "reflects": true
9375
+ "privacy": "private"
9328
9376
  },
9329
9377
  {
9330
9378
  "kind": "field",
9331
- "name": "appearance",
9332
- "privacy": "public",
9333
- "type": {
9334
- "text": "string"
9379
+ "name": "buttonElementTags",
9380
+ "static": true,
9381
+ "readonly": true
9382
+ },
9383
+ {
9384
+ "kind": "method",
9385
+ "name": "isButtonElement",
9386
+ "parameters": [
9387
+ {
9388
+ "name": "element",
9389
+ "description": "The element to check.",
9390
+ "type": {
9391
+ "text": "HTMLElement"
9392
+ }
9393
+ }
9394
+ ],
9395
+ "description": "Check if the tag name is a button element.",
9396
+ "return": {
9397
+ "type": {
9398
+ "text": "boolean"
9399
+ }
9335
9400
  },
9336
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
9337
- "default": "\"default\"",
9338
- "attribute": "appearance",
9339
- "reflects": true
9401
+ "privacy": "private"
9340
9402
  },
9341
9403
  {
9342
9404
  "kind": "field",
9343
- "name": "onDark",
9344
- "privacy": "public",
9345
- "type": {
9346
- "text": "boolean"
9405
+ "name": "value",
9406
+ "description": "Returns the current values of all named form elements as a key-value object, keyed by each element's `name` attribute.",
9407
+ "return": {
9408
+ "type": {
9409
+ "text": "Record<string, string | number | boolean | string[] | null>"
9410
+ }
9347
9411
  },
9348
- "description": "DEPRECATED - use `appearance` instead.",
9349
- "default": "false",
9350
- "attribute": "onDark",
9351
- "reflects": true
9412
+ "readonly": true
9352
9413
  },
9353
9414
  {
9354
9415
  "kind": "field",
9355
- "name": "hasTextContent",
9356
- "privacy": "private",
9357
- "type": {
9358
- "text": "boolean"
9416
+ "name": "submitElements",
9417
+ "description": "Getter for internal _submitElements.",
9418
+ "return": {
9419
+ "type": {
9420
+ "text": "HTMLButtonElement[]"
9421
+ }
9359
9422
  },
9360
- "default": "false",
9361
- "attribute": "hasTextContent"
9423
+ "privacy": "private",
9424
+ "readonly": true
9362
9425
  },
9363
9426
  {
9364
9427
  "kind": "field",
9365
- "name": "slotNodes",
9366
- "privacy": "private",
9367
- "type": {
9368
- "text": "boolean"
9428
+ "name": "resetElements",
9429
+ "description": "Returns a collection of elements that will reset the form.",
9430
+ "return": {
9431
+ "type": {
9432
+ "text": "HTMLButtonElement[]"
9433
+ }
9369
9434
  },
9370
- "attribute": "slotNodes"
9371
- }
9372
- ],
9373
- "attributes": [
9435
+ "privacy": "private",
9436
+ "readonly": true
9437
+ },
9374
9438
  {
9375
- "name": "appearance",
9376
- "type": {
9377
- "text": "string"
9439
+ "kind": "method",
9440
+ "name": "_calculateValidity",
9441
+ "description": "Infer validity status based on current formState.",
9442
+ "privacy": "private"
9443
+ },
9444
+ {
9445
+ "kind": "field",
9446
+ "name": "validity",
9447
+ "description": "Returns `'valid'` if all required and interacted-with form elements are valid, `'invalid'` if any are not, or `null` if the form has not been interacted with yet.",
9448
+ "return": {
9449
+ "type": {
9450
+ "text": "\"valid\" | \"invalid\" | null"
9451
+ }
9378
9452
  },
9379
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
9380
- "default": "\"default\"",
9381
- "fieldName": "appearance"
9453
+ "readonly": true
9382
9454
  },
9383
9455
  {
9384
- "name": "slotNodes",
9385
- "type": {
9386
- "text": "boolean"
9456
+ "kind": "method",
9457
+ "name": "_setInitialState",
9458
+ "description": "Determines whether the form is in its initial (untouched) state and updates `_isInitialState` accordingly.",
9459
+ "return": {
9460
+ "type": {
9461
+ "text": "void"
9462
+ }
9387
9463
  },
9388
- "fieldName": "slotNodes"
9464
+ "privacy": "private"
9389
9465
  },
9390
9466
  {
9391
- "name": "hasTextContent",
9392
- "type": {
9393
- "text": "boolean"
9467
+ "kind": "field",
9468
+ "name": "isInitialState",
9469
+ "description": "Returns `true` if no form element has been interacted with or had its value changed since the form was initialized or last reset.",
9470
+ "return": {
9471
+ "type": {
9472
+ "text": "boolean"
9473
+ }
9394
9474
  },
9395
- "default": "false",
9396
- "fieldName": "hasTextContent"
9475
+ "readonly": true
9397
9476
  },
9398
9477
  {
9399
- "name": "error",
9400
- "type": {
9401
- "text": "boolean"
9478
+ "kind": "method",
9479
+ "name": "setDisabledStateOnButtons",
9480
+ "description": "Enables or disables submit and reset buttons based on the current form state and validity.",
9481
+ "return": {
9482
+ "type": {
9483
+ "text": "void"
9484
+ }
9402
9485
  },
9403
- "description": "If declared, make font color red.",
9404
- "default": "false",
9405
- "fieldName": "error"
9486
+ "privacy": "private"
9406
9487
  },
9407
9488
  {
9408
- "name": "onDark",
9409
- "type": {
9410
- "text": "boolean"
9489
+ "kind": "method",
9490
+ "name": "queryAuroElements",
9491
+ "description": "Construct the query strings from elements, append them together, execute, and return the NodeList.",
9492
+ "return": {
9493
+ "type": {
9494
+ "text": "NodeList"
9495
+ }
9411
9496
  },
9412
- "description": "DEPRECATED - use `appearance` instead.",
9413
- "default": "false",
9414
- "fieldName": "onDark"
9415
- }
9416
- ],
9417
- "superclass": {
9418
- "name": "LitElement",
9419
- "package": "lit"
9420
- },
9421
- "customElement": true
9422
- }
9423
- ],
9424
- "exports": [
9425
- {
9426
- "kind": "js",
9427
- "name": "AuroHelpText",
9428
- "declaration": {
9429
- "name": "AuroHelpText",
9430
- "module": "components/helptext/src/auro-helptext.js"
9431
- }
9432
- }
9433
- ]
9434
- },
9435
- {
9436
- "kind": "javascript-module",
9437
- "path": "components/helptext/src/index.js",
9438
- "declarations": [],
9439
- "exports": [
9440
- {
9441
- "kind": "js",
9442
- "name": "AuroHelpText",
9443
- "declaration": {
9444
- "name": "AuroHelpText",
9445
- "module": "components/helptext/src/index.js"
9446
- }
9447
- }
9448
- ]
9449
- },
9450
- {
9451
- "kind": "javascript-module",
9452
- "path": "components/helptext/src/registered.js",
9453
- "declarations": [],
9454
- "exports": []
9455
- },
9456
- {
9457
- "kind": "javascript-module",
9458
- "path": "components/input/src/auro-input.js",
9459
- "declarations": [
9460
- {
9461
- "kind": "class",
9462
- "description": "The `auro-input` element provides users a way to enter data into a text field.",
9463
- "name": "AuroInput",
9464
- "cssParts": [
9465
- {
9466
- "description": "Use for customizing the style of the root element",
9467
- "name": "wrapper"
9468
- },
9469
- {
9470
- "description": "Use for customizing the style of the label element",
9471
- "name": "label"
9472
- },
9473
- {
9474
- "description": "Use for customizing the style of the helpText element",
9475
- "name": "helpText"
9476
- },
9477
- {
9478
- "description": "Use for customizing the style of the input element",
9479
- "name": "input"
9480
- },
9481
- {
9482
- "description": "Use for customizing the style of the accentIcon element (e.g. credit card icon, calendar icon)",
9483
- "name": "accentIcon"
9484
- },
9485
- {
9486
- "description": "Use for customizing the style of the iconContainer (e.g. X icon for clearing input value)",
9487
- "name": "iconContainer"
9488
- },
9489
- {
9490
- "description": "Use for customizing the style of the left accent element (e.g. padding, margin)",
9491
- "name": "accent-left"
9492
- },
9493
- {
9494
- "description": "Use for customizing the style of the right accent element (e.g. padding, margin)",
9495
- "name": "accent-right"
9497
+ "privacy": "private"
9496
9498
  },
9497
9499
  {
9498
- "description": "Use for customizing the style of the displayValue element",
9499
- "name": "displayValue"
9500
+ "kind": "method",
9501
+ "name": "_addElementToState",
9502
+ "parameters": [
9503
+ {
9504
+ "name": "element",
9505
+ "description": "The element to add to our state.",
9506
+ "type": {
9507
+ "text": "HTMLElement"
9508
+ }
9509
+ }
9510
+ ],
9511
+ "description": "Store an element in state and on the _elements array.",
9512
+ "privacy": "private"
9500
9513
  },
9501
9514
  {
9502
- "description": "Use for customizing the style of the input help text wrapper",
9503
- "name": "inputHelpText"
9504
- }
9505
- ],
9506
- "slots": [
9507
- {
9508
- "description": "Sets aria-label on clear button for screen reader to read",
9509
- "name": "ariaLabel.clear"
9515
+ "kind": "method",
9516
+ "name": "initializeState",
9517
+ "description": "Initialize (or reinitialize) the form state.",
9518
+ "return": {
9519
+ "type": {
9520
+ "text": "void"
9521
+ }
9522
+ },
9523
+ "privacy": "private"
9510
9524
  },
9511
9525
  {
9512
- "description": "Sets aria-label on password button to toggle on showing password",
9513
- "name": "ariaLabel.password.show"
9526
+ "kind": "method",
9527
+ "name": "reset",
9528
+ "description": "Resets all form elements to their initial state and fires a `reset` event. The event's `detail.previousValue` contains the form values captured immediately before the reset.",
9529
+ "return": {
9530
+ "type": {
9531
+ "text": "void"
9532
+ }
9533
+ }
9514
9534
  },
9515
9535
  {
9516
- "description": "Sets aria-label on password button to toggle off showing password",
9517
- "name": "ariaLabel.password.hide"
9536
+ "kind": "method",
9537
+ "name": "submit",
9538
+ "description": "Validates all form elements. If all are valid, fires a `submit` event with `detail.value` containing the current form values. If any element is invalid, its error state is surfaced and the `submit` event is not fired.",
9539
+ "return": {
9540
+ "type": {
9541
+ "text": "Promise<void>"
9542
+ }
9543
+ }
9518
9544
  },
9519
9545
  {
9520
- "description": "Sets the help text displayed below the input.",
9521
- "name": "helpText"
9546
+ "kind": "method",
9547
+ "name": "register",
9548
+ "static": true,
9549
+ "parameters": [
9550
+ {
9551
+ "name": "name",
9552
+ "default": "\"auro-form\"",
9553
+ "description": "The custom element tag name to register.",
9554
+ "optional": true,
9555
+ "type": {
9556
+ "text": "string"
9557
+ }
9558
+ }
9559
+ ],
9560
+ "description": "Registers the `auro-form` custom element with the browser under a given tag name."
9522
9561
  },
9523
9562
  {
9524
- "description": "Sets the label text for the input.",
9525
- "name": "label"
9563
+ "kind": "method",
9564
+ "name": "sharedInputListener",
9565
+ "parameters": [
9566
+ {
9567
+ "name": "event",
9568
+ "description": "The event that is fired from the form element.",
9569
+ "type": {
9570
+ "text": "Event"
9571
+ }
9572
+ }
9573
+ ],
9574
+ "description": "Shared input listener for all form elements.",
9575
+ "privacy": "private"
9526
9576
  },
9527
9577
  {
9528
- "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
9529
- "name": "optionalLabel"
9578
+ "kind": "method",
9579
+ "name": "sharedValidationListener",
9580
+ "parameters": [
9581
+ {
9582
+ "name": "event",
9583
+ "description": "The event that is fired from the form element.",
9584
+ "type": {
9585
+ "text": "Event"
9586
+ }
9587
+ }
9588
+ ],
9589
+ "description": "Shared validation listener for all form elements.",
9590
+ "privacy": "private"
9530
9591
  },
9531
9592
  {
9532
- "description": "Allows custom HTML content to display in place of the value when the input is not focused.",
9533
- "name": "displayValue"
9534
- }
9535
- ],
9536
- "members": [
9537
- {
9538
- "kind": "field",
9539
- "name": "clearBtnClassMap",
9540
- "description": "Returns classmap configuration for the clear button visibility.\nThe button is hidden when the input has no value, is read-only, or is disabled.",
9541
- "privacy": "private",
9542
- "return": {
9543
- "type": {
9544
- "text": "Record<string, boolean>"
9593
+ "kind": "method",
9594
+ "name": "handleKeyDown",
9595
+ "parameters": [
9596
+ {
9597
+ "name": "event",
9598
+ "description": "The keyboard event.",
9599
+ "type": {
9600
+ "text": "KeyboardEvent"
9601
+ }
9545
9602
  }
9546
- },
9547
- "readonly": true
9603
+ ],
9604
+ "description": "Handle Enter key press on form elements.",
9605
+ "privacy": "private"
9548
9606
  },
9549
9607
  {
9550
- "kind": "field",
9551
- "name": "inputHidden",
9552
- "description": "Determines if the HTML input element should be visually hidden.\nReturns true when display value content exists without focus and has a value,\nor when the input has no value, is not focused, and has no placeholder text.",
9608
+ "kind": "method",
9609
+ "name": "_attachEventListeners",
9610
+ "description": "Attaches input, validation, and keydown listeners to all tracked form and button elements.\nRemoves existing listeners first to avoid duplicates on re-initialization.",
9553
9611
  "return": {
9554
9612
  "type": {
9555
- "text": "boolean"
9613
+ "text": "void"
9556
9614
  }
9557
9615
  },
9558
- "privacy": "private",
9559
- "readonly": true
9616
+ "privacy": "private"
9560
9617
  },
9561
9618
  {
9562
- "kind": "field",
9563
- "name": "noFocusOrValue",
9564
- "description": "Determines if the input should display in a state with no focus or value indication.\nReturns true when the input has display content without focus and has a value,\nor when the input has no value and is not focused.",
9619
+ "kind": "method",
9620
+ "name": "mutationEventListener",
9621
+ "description": "Mutation observer for form elements. Slot change does not trigger unless\nroot-level elements are added/removed. This is a workaround to ensure\nnested form elements are also observed.",
9565
9622
  "return": {
9566
9623
  "type": {
9567
- "text": "boolean"
9624
+ "text": "void"
9568
9625
  }
9569
9626
  },
9570
- "privacy": "private",
9571
- "readonly": true
9627
+ "privacy": "private"
9572
9628
  },
9573
9629
  {
9574
- "kind": "field",
9575
- "name": "labelHidden",
9576
- "description": "Whether the label is being hidden currently based on state.",
9630
+ "kind": "method",
9631
+ "name": "onSlotChange",
9632
+ "parameters": [
9633
+ {
9634
+ "name": "event",
9635
+ "description": "The slot change event.",
9636
+ "type": {
9637
+ "text": "Event"
9638
+ }
9639
+ }
9640
+ ],
9641
+ "description": "Slot change event listener. This is the main entry point for the form element.",
9577
9642
  "return": {
9578
9643
  "type": {
9579
- "text": "boolean"
9644
+ "text": "void"
9580
9645
  }
9581
9646
  },
9582
- "privacy": "private",
9583
- "readonly": true
9647
+ "privacy": "private"
9584
9648
  },
9585
9649
  {
9586
9650
  "kind": "field",
9587
- "name": "labelFontClass",
9588
- "description": "Returns the label font class based on layout and visibility state.",
9651
+ "name": "formState",
9589
9652
  "privacy": "private",
9590
- "return": {
9591
- "type": {
9592
- "text": "string"
9593
- }
9653
+ "type": {
9654
+ "text": "FormState"
9594
9655
  },
9595
- "readonly": true
9656
+ "default": "{}"
9596
9657
  },
9597
9658
  {
9598
9659
  "kind": "field",
9599
- "name": "inputFontClass",
9600
- "description": "Returns the input font class based on layout and visibility state.",
9660
+ "name": "_validity",
9601
9661
  "privacy": "private",
9602
- "return": {
9603
- "type": {
9604
- "text": "string"
9605
- }
9662
+ "type": {
9663
+ "text": "\"valid\" | \"invalid\" | null"
9606
9664
  },
9607
- "readonly": true
9665
+ "default": "null"
9608
9666
  },
9609
9667
  {
9610
9668
  "kind": "field",
9611
- "name": "commonLabelClasses",
9612
- "description": "Returns classmap configuration for html5 input labels in all layouts.",
9669
+ "name": "_isInitialState",
9613
9670
  "privacy": "private",
9614
- "return": {
9615
- "type": {
9616
- "text": "Record<string, boolean>"
9617
- }
9671
+ "type": {
9672
+ "text": "boolean"
9618
9673
  },
9619
- "readonly": true
9674
+ "default": "true"
9620
9675
  },
9621
9676
  {
9622
9677
  "kind": "field",
9623
- "name": "commonInputClasses",
9624
- "description": "Returns classmap configuration for html5 inputs in all layouts.",
9678
+ "name": "_elements",
9625
9679
  "privacy": "private",
9626
- "return": {
9627
- "type": {
9628
- "text": "Record<string, boolean>"
9629
- }
9680
+ "type": {
9681
+ "text": "(HTMLElement & {reset: () => void})[]"
9630
9682
  },
9631
- "readonly": true
9683
+ "default": "[]"
9632
9684
  },
9633
9685
  {
9634
9686
  "kind": "field",
9635
- "name": "commonDisplayValueWrapperClasses",
9636
- "description": "Common display value wrapper classes.",
9687
+ "name": "_submitElements",
9637
9688
  "privacy": "private",
9638
- "return": {
9639
- "type": {
9640
- "text": "Record<string, boolean>"
9641
- }
9689
+ "type": {
9690
+ "text": "HTMLButtonElement[]"
9642
9691
  },
9643
- "readonly": true
9692
+ "default": "[]"
9644
9693
  },
9645
9694
  {
9646
9695
  "kind": "field",
9647
- "name": "legacyInputClasses",
9648
- "description": "Returns classmap configuration for html5 inputs in each layout.",
9696
+ "name": "_resetElements",
9649
9697
  "privacy": "private",
9650
- "return": {
9651
- "type": {
9652
- "text": "object"
9653
- }
9698
+ "type": {
9699
+ "text": "HTMLButtonElement[]"
9654
9700
  },
9655
- "readonly": true
9701
+ "default": "[]"
9656
9702
  },
9657
9703
  {
9658
9704
  "kind": "field",
9659
- "name": "commonWrapperClasses",
9660
- "description": "Returns classmap configuration for wrapper elements in each layout.",
9705
+ "name": "mutationObservers",
9706
+ "type": {
9707
+ "text": "MutationObserver[]"
9708
+ },
9661
9709
  "privacy": "private",
9662
- "return": {
9663
- "type": {
9664
- "text": "object"
9665
- }
9710
+ "default": "[]"
9711
+ }
9712
+ ],
9713
+ "events": [
9714
+ {
9715
+ "name": "change",
9716
+ "type": {
9717
+ "text": "Event"
9666
9718
  },
9667
- "readonly": true
9719
+ "description": "Fires when a child form element's value changes or the form is initialized."
9668
9720
  },
9669
9721
  {
9670
- "kind": "field",
9671
- "name": "helpTextClasses",
9672
- "description": "Returns classmap configuration for helpText elements in each layout.",
9673
- "privacy": "private",
9674
- "return": {
9675
- "type": {
9676
- "text": "object"
9677
- }
9722
+ "name": "reset",
9723
+ "type": {
9724
+ "text": "CustomEvent"
9678
9725
  },
9679
- "readonly": true
9726
+ "description": "Fires when the form is reset. The event detail contains the previous value of the form before reset."
9727
+ },
9728
+ {
9729
+ "name": "submit",
9730
+ "type": {
9731
+ "text": "CustomEvent"
9732
+ },
9733
+ "description": "Fires when the form is submitted. The event detail contains the current value of the form."
9680
9734
  },
9735
+ {
9736
+ "description": "Fires when a child form element receives user input.",
9737
+ "name": "input"
9738
+ }
9739
+ ],
9740
+ "superclass": {
9741
+ "name": "LitElement",
9742
+ "package": "lit"
9743
+ },
9744
+ "tagName": "auro-form",
9745
+ "customElement": true
9746
+ }
9747
+ ],
9748
+ "exports": [
9749
+ {
9750
+ "kind": "js",
9751
+ "name": "AuroForm",
9752
+ "declaration": {
9753
+ "name": "AuroForm",
9754
+ "module": "components/form/src/auro-form.js"
9755
+ }
9756
+ }
9757
+ ]
9758
+ },
9759
+ {
9760
+ "kind": "javascript-module",
9761
+ "path": "components/form/src/index.js",
9762
+ "declarations": [],
9763
+ "exports": [
9764
+ {
9765
+ "kind": "js",
9766
+ "name": "AuroForm",
9767
+ "declaration": {
9768
+ "name": "AuroForm",
9769
+ "module": "components/form/src/index.js"
9770
+ }
9771
+ }
9772
+ ]
9773
+ },
9774
+ {
9775
+ "kind": "javascript-module",
9776
+ "path": "components/form/src/registered.js",
9777
+ "declarations": [],
9778
+ "exports": []
9779
+ },
9780
+ {
9781
+ "kind": "javascript-module",
9782
+ "path": "components/helptext/src/auro-helptext.js",
9783
+ "declarations": [
9784
+ {
9785
+ "kind": "class",
9786
+ "description": "Displays help text or error messages within form elements - Internal Use Only.",
9787
+ "name": "AuroHelpText",
9788
+ "members": [
9681
9789
  {
9682
9790
  "kind": "method",
9683
9791
  "name": "register",
@@ -9685,8 +9793,8 @@
9685
9793
  "parameters": [
9686
9794
  {
9687
9795
  "name": "name",
9688
- "default": "\"auro-input\"",
9689
- "description": "The name of the element that you want to register.",
9796
+ "default": "\"auro-helptext\"",
9797
+ "description": "The name of element that you want to register to.",
9690
9798
  "optional": true,
9691
9799
  "type": {
9692
9800
  "text": "string"
@@ -9697,545 +9805,601 @@
9697
9805
  },
9698
9806
  {
9699
9807
  "kind": "method",
9700
- "name": "hasTypeIcon",
9701
- "description": "Function to determine if the input is meant to render an icon visualizing the input type.",
9702
- "privacy": "private",
9703
- "return": {
9704
- "type": {
9705
- "text": "boolean"
9706
- }
9707
- }
9708
- },
9709
- {
9710
- "kind": "method",
9711
- "name": "checkDisplayValueSlotChange",
9712
- "description": "Function to determine if there is any displayValue content to render.",
9713
- "privacy": "private",
9714
- "return": {
9715
- "type": {
9716
- "text": "void"
9717
- }
9718
- }
9719
- },
9720
- {
9721
- "kind": "method",
9722
- "name": "renderValidationErrorIconHtml",
9723
- "description": "Returns HTML for the validation error icon.",
9724
- "privacy": "private",
9725
- "return": {
9726
- "type": {
9727
- "text": "html"
9808
+ "name": "handleSlotChange",
9809
+ "parameters": [
9810
+ {
9811
+ "name": "event"
9728
9812
  }
9729
- }
9813
+ ]
9730
9814
  },
9731
9815
  {
9732
9816
  "kind": "method",
9733
- "name": "renderHtmlInput",
9817
+ "name": "checkSlotsForContent",
9734
9818
  "parameters": [
9735
9819
  {
9736
- "name": "useLegacyHiddenState",
9737
- "default": "false",
9738
- "description": "If true, the input will be visually hidden when not focused and has no value.",
9739
- "optional": true,
9820
+ "name": "nodes",
9821
+ "description": "The list of nodes to check for content.",
9740
9822
  "type": {
9741
- "text": "boolean"
9823
+ "text": "NodeList|Array"
9742
9824
  }
9743
9825
  }
9744
9826
  ],
9745
- "description": "Returns HTML for the HTML5 input element.",
9746
- "privacy": "private",
9747
- "return": {
9748
- "type": {
9749
- "text": "html"
9750
- }
9751
- }
9752
- },
9753
- {
9754
- "kind": "method",
9755
- "name": "renderHtmlActionClear",
9756
- "description": "Returns HTML for the clear action button.",
9757
- "privacy": "private",
9827
+ "description": "Checks if any of the provided nodes or their nested slot nodes contain non-empty text content.",
9758
9828
  "return": {
9759
9829
  "type": {
9760
- "text": "html"
9830
+ "text": "boolean"
9761
9831
  }
9762
- }
9832
+ },
9833
+ "privacy": "private"
9763
9834
  },
9764
9835
  {
9765
- "kind": "method",
9766
- "name": "renderHtmlNotificationPassword",
9767
- "description": "Returns HTML for the show password button.",
9768
- "privacy": "private",
9769
- "return": {
9770
- "type": {
9771
- "text": "html"
9772
- }
9773
- }
9836
+ "kind": "field",
9837
+ "name": "error",
9838
+ "privacy": "public",
9839
+ "type": {
9840
+ "text": "boolean"
9841
+ },
9842
+ "description": "If declared, make font color red.",
9843
+ "default": "false",
9844
+ "attribute": "error",
9845
+ "reflects": true
9774
9846
  },
9775
9847
  {
9776
- "kind": "method",
9777
- "name": "renderHtmlTypeIcon",
9778
- "description": "Returns HTML for the input type icon.",
9779
- "privacy": "private",
9780
- "return": {
9781
- "type": {
9782
- "text": "html"
9783
- }
9784
- }
9848
+ "kind": "field",
9849
+ "name": "appearance",
9850
+ "privacy": "public",
9851
+ "type": {
9852
+ "text": "string"
9853
+ },
9854
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
9855
+ "default": "\"default\"",
9856
+ "attribute": "appearance",
9857
+ "reflects": true
9785
9858
  },
9786
9859
  {
9787
- "kind": "method",
9788
- "name": "renderHtmlHelpText",
9789
- "description": "Returns HTML for the help text and error message.",
9790
- "privacy": "private",
9791
- "return": {
9792
- "type": {
9793
- "text": "html"
9794
- }
9795
- }
9860
+ "kind": "field",
9861
+ "name": "onDark",
9862
+ "privacy": "public",
9863
+ "type": {
9864
+ "text": "boolean"
9865
+ },
9866
+ "description": "DEPRECATED - use `appearance` instead.",
9867
+ "default": "false",
9868
+ "attribute": "onDark",
9869
+ "reflects": true
9796
9870
  },
9797
9871
  {
9798
- "kind": "method",
9799
- "name": "renderLayoutClassic",
9800
- "description": "Returns HTML for the classic layout.",
9872
+ "kind": "field",
9873
+ "name": "hasTextContent",
9801
9874
  "privacy": "private",
9802
- "return": {
9803
- "type": {
9804
- "text": "TemplateResult"
9805
- }
9806
- }
9875
+ "type": {
9876
+ "text": "boolean"
9877
+ },
9878
+ "default": "false",
9879
+ "attribute": "hasTextContent"
9807
9880
  },
9808
9881
  {
9809
- "kind": "method",
9810
- "name": "renderLayoutEmphasized",
9811
- "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".",
9882
+ "kind": "field",
9883
+ "name": "slotNodes",
9812
9884
  "privacy": "private",
9813
- "return": {
9814
- "type": {
9815
- "text": "html"
9816
- }
9817
- }
9818
- },
9885
+ "type": {
9886
+ "text": "boolean"
9887
+ },
9888
+ "attribute": "slotNodes"
9889
+ }
9890
+ ],
9891
+ "attributes": [
9819
9892
  {
9820
- "kind": "method",
9821
- "name": "renderLayoutSnowflake",
9822
- "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".",
9823
- "privacy": "private",
9824
- "return": {
9825
- "type": {
9826
- "text": "html"
9827
- }
9828
- }
9893
+ "name": "appearance",
9894
+ "type": {
9895
+ "text": "string"
9896
+ },
9897
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
9898
+ "default": "\"default\"",
9899
+ "fieldName": "appearance"
9829
9900
  },
9830
9901
  {
9831
- "kind": "method",
9832
- "name": "renderLayout",
9833
- "parameters": [
9834
- {
9835
- "name": "ForcedLayout",
9836
- "description": "Used to force a specific layout, pass in the layout name to use.",
9837
- "optional": true,
9838
- "type": {
9839
- "text": "string"
9840
- }
9841
- }
9842
- ],
9843
- "description": "Logic to determine the layout of the component.",
9844
- "privacy": "private",
9845
- "return": {
9846
- "type": {
9847
- "text": "void"
9848
- }
9849
- }
9902
+ "name": "slotNodes",
9903
+ "type": {
9904
+ "text": "boolean"
9905
+ },
9906
+ "fieldName": "slotNodes"
9850
9907
  },
9851
9908
  {
9852
- "kind": "field",
9853
- "name": "buttonTag",
9854
- "privacy": "private"
9909
+ "name": "hasTextContent",
9910
+ "type": {
9911
+ "text": "boolean"
9912
+ },
9913
+ "default": "false",
9914
+ "fieldName": "hasTextContent"
9855
9915
  },
9856
9916
  {
9857
- "kind": "field",
9858
- "name": "hasDisplayValueContent",
9917
+ "name": "error",
9859
9918
  "type": {
9860
9919
  "text": "boolean"
9861
9920
  },
9862
- "privacy": "private",
9863
- "default": "false"
9921
+ "description": "If declared, make font color red.",
9922
+ "default": "false",
9923
+ "fieldName": "error"
9864
9924
  },
9865
9925
  {
9866
- "kind": "field",
9867
- "name": "helpTextTag",
9868
- "privacy": "private"
9926
+ "name": "onDark",
9927
+ "type": {
9928
+ "text": "boolean"
9929
+ },
9930
+ "description": "DEPRECATED - use `appearance` instead.",
9931
+ "default": "false",
9932
+ "fieldName": "onDark"
9933
+ }
9934
+ ],
9935
+ "superclass": {
9936
+ "name": "LitElement",
9937
+ "package": "lit"
9938
+ },
9939
+ "customElement": true
9940
+ }
9941
+ ],
9942
+ "exports": [
9943
+ {
9944
+ "kind": "js",
9945
+ "name": "AuroHelpText",
9946
+ "declaration": {
9947
+ "name": "AuroHelpText",
9948
+ "module": "components/helptext/src/auro-helptext.js"
9949
+ }
9950
+ }
9951
+ ]
9952
+ },
9953
+ {
9954
+ "kind": "javascript-module",
9955
+ "path": "components/helptext/src/index.js",
9956
+ "declarations": [],
9957
+ "exports": [
9958
+ {
9959
+ "kind": "js",
9960
+ "name": "AuroHelpText",
9961
+ "declaration": {
9962
+ "name": "AuroHelpText",
9963
+ "module": "components/helptext/src/index.js"
9964
+ }
9965
+ }
9966
+ ]
9967
+ },
9968
+ {
9969
+ "kind": "javascript-module",
9970
+ "path": "components/helptext/src/registered.js",
9971
+ "declarations": [],
9972
+ "exports": []
9973
+ },
9974
+ {
9975
+ "kind": "javascript-module",
9976
+ "path": "components/input/src/auro-input.js",
9977
+ "declarations": [
9978
+ {
9979
+ "kind": "class",
9980
+ "description": "The `auro-input` element provides users a way to enter data into a text field.",
9981
+ "name": "AuroInput",
9982
+ "cssParts": [
9983
+ {
9984
+ "description": "Use for customizing the style of the root element",
9985
+ "name": "wrapper"
9869
9986
  },
9870
9987
  {
9871
- "kind": "field",
9872
- "name": "iconTag",
9873
- "privacy": "private"
9988
+ "description": "Use for customizing the style of the label element",
9989
+ "name": "label"
9874
9990
  },
9875
9991
  {
9876
- "kind": "field",
9877
- "name": "clearButtonRef",
9878
- "privacy": "private"
9992
+ "description": "Use for customizing the style of the helpText element",
9993
+ "name": "helpText"
9879
9994
  },
9880
9995
  {
9881
- "kind": "field",
9882
- "name": "shadowRootOptions",
9883
- "static": true,
9884
- "readonly": true,
9885
- "inheritedFrom": {
9886
- "name": "BaseInput",
9887
- "module": "components/input/src/base-input.js"
9888
- }
9996
+ "description": "Use for customizing the style of the input element",
9997
+ "name": "input"
9889
9998
  },
9890
9999
  {
9891
- "kind": "method",
9892
- "name": "_initializeDefaults",
9893
- "description": "Internal Defaults.",
9894
- "privacy": "private",
9895
- "return": {
9896
- "type": {
9897
- "text": "void"
9898
- }
9899
- },
9900
- "inheritedFrom": {
9901
- "name": "BaseInput",
9902
- "module": "components/input/src/base-input.js"
9903
- }
10000
+ "description": "Use for customizing the style of the accentIcon element (e.g. credit card icon, calendar icon)",
10001
+ "name": "accentIcon"
9904
10002
  },
9905
10003
  {
9906
- "kind": "method",
9907
- "name": "patchInputEvent",
9908
- "parameters": [
9909
- {
9910
- "name": "input",
9911
- "description": "The input element to patch.",
9912
- "type": {
9913
- "text": "HTMLInputElement"
9914
- }
9915
- }
9916
- ],
9917
- "description": "Patches the input element to dispatch an 'input' event whenever its value is set programmatically.\nThis ensures that changes to the input's value are consistently communicated, even if not triggered by user input.",
9918
- "return": {
9919
- "type": {
9920
- "text": "void"
9921
- }
9922
- },
9923
- "privacy": "private",
9924
- "inheritedFrom": {
9925
- "name": "BaseInput",
9926
- "module": "components/input/src/base-input.js"
9927
- }
10004
+ "description": "Use for customizing the style of the iconContainer (e.g. X icon for clearing input value)",
10005
+ "name": "iconContainer"
9928
10006
  },
9929
10007
  {
9930
- "kind": "method",
9931
- "name": "setCustomHelpTextMessage",
9932
- "privacy": "private",
9933
- "return": {
9934
- "type": {
9935
- "text": "void"
9936
- }
9937
- },
9938
- "inheritedFrom": {
9939
- "name": "BaseInput",
9940
- "module": "components/input/src/base-input.js"
9941
- }
10008
+ "description": "Use for customizing the style of the left accent element (e.g. padding, margin)",
10009
+ "name": "accent-left"
9942
10010
  },
9943
10011
  {
9944
- "kind": "method",
9945
- "name": "notifyValidityChange",
9946
- "privacy": "private",
9947
- "return": {
9948
- "type": {
9949
- "text": "void"
9950
- }
9951
- },
9952
- "inheritedFrom": {
9953
- "name": "BaseInput",
9954
- "module": "components/input/src/base-input.js"
9955
- }
10012
+ "description": "Use for customizing the style of the right accent element (e.g. padding, margin)",
10013
+ "name": "accent-right"
9956
10014
  },
9957
10015
  {
9958
- "kind": "method",
9959
- "name": "configureAutoFormatting",
9960
- "description": "Sets up IMasks and logic based on auto-formatting requirements.",
10016
+ "description": "Use for customizing the style of the displayValue element",
10017
+ "name": "displayValue"
10018
+ },
10019
+ {
10020
+ "description": "Use for customizing the style of the input help text wrapper",
10021
+ "name": "inputHelpText"
10022
+ }
10023
+ ],
10024
+ "slots": [
10025
+ {
10026
+ "description": "Sets aria-label on clear button for screen reader to read",
10027
+ "name": "ariaLabel.clear"
10028
+ },
10029
+ {
10030
+ "description": "Sets aria-label on password button to toggle on showing password",
10031
+ "name": "ariaLabel.password.show"
10032
+ },
10033
+ {
10034
+ "description": "Sets aria-label on password button to toggle off showing password",
10035
+ "name": "ariaLabel.password.hide"
10036
+ },
10037
+ {
10038
+ "description": "Sets the help text displayed below the input.",
10039
+ "name": "helpText"
10040
+ },
10041
+ {
10042
+ "description": "Sets the label text for the input.",
10043
+ "name": "label"
10044
+ },
10045
+ {
10046
+ "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
10047
+ "name": "optionalLabel"
10048
+ },
10049
+ {
10050
+ "description": "Allows custom HTML content to display in place of the value when the input is not focused.",
10051
+ "name": "displayValue"
10052
+ }
10053
+ ],
10054
+ "members": [
10055
+ {
10056
+ "kind": "field",
10057
+ "name": "clearBtnClassMap",
10058
+ "description": "Returns classmap configuration for the clear button visibility.\nThe button is hidden when the input has no value, is read-only, or is disabled.",
9961
10059
  "privacy": "private",
9962
10060
  "return": {
9963
10061
  "type": {
9964
- "text": "void"
10062
+ "text": "Record<string, boolean>"
9965
10063
  }
9966
10064
  },
9967
- "inheritedFrom": {
9968
- "name": "BaseInput",
9969
- "module": "components/input/src/base-input.js"
9970
- }
10065
+ "readonly": true
9971
10066
  },
9972
10067
  {
9973
- "kind": "method",
9974
- "name": "definePattern",
9975
- "privacy": "private",
10068
+ "kind": "field",
10069
+ "name": "inputHidden",
10070
+ "description": "Determines if the HTML input element should be visually hidden.\nReturns true when display value content exists without focus and has a value,\nor when the input has no value, is not focused, and has no placeholder text.",
9976
10071
  "return": {
9977
10072
  "type": {
9978
- "text": "string"
10073
+ "text": "boolean"
9979
10074
  }
9980
10075
  },
9981
- "inheritedFrom": {
9982
- "name": "BaseInput",
9983
- "module": "components/input/src/base-input.js"
9984
- }
10076
+ "privacy": "private",
10077
+ "readonly": true
9985
10078
  },
9986
10079
  {
9987
- "kind": "method",
9988
- "name": "notifyValueChanged",
9989
- "description": "Sends event notifying that the input has changed it's value.",
9990
- "privacy": "private",
10080
+ "kind": "field",
10081
+ "name": "noFocusOrValue",
10082
+ "description": "Determines if the input should display in a state with no focus or value indication.\nReturns true when the input has display content without focus and has a value,\nor when the input has no value and is not focused.",
9991
10083
  "return": {
9992
10084
  "type": {
9993
- "text": "void"
10085
+ "text": "boolean"
9994
10086
  }
9995
10087
  },
9996
- "inheritedFrom": {
9997
- "name": "BaseInput",
9998
- "module": "components/input/src/base-input.js"
9999
- }
10088
+ "privacy": "private",
10089
+ "readonly": true
10000
10090
  },
10001
10091
  {
10002
- "kind": "method",
10003
- "name": "handleClick",
10004
- "description": "Handles clicking on the auro-input anywhere outside of the HTML5 input and still moving focus in.",
10005
- "privacy": "private",
10092
+ "kind": "field",
10093
+ "name": "labelHidden",
10094
+ "description": "Whether the label is being hidden currently based on state.",
10006
10095
  "return": {
10007
10096
  "type": {
10008
- "text": "void"
10097
+ "text": "boolean"
10009
10098
  }
10010
10099
  },
10011
- "inheritedFrom": {
10012
- "name": "BaseInput",
10013
- "module": "components/input/src/base-input.js"
10014
- }
10100
+ "privacy": "private",
10101
+ "readonly": true
10015
10102
  },
10016
10103
  {
10017
- "kind": "method",
10018
- "name": "focus",
10019
- "description": "Function to set element focus.",
10104
+ "kind": "field",
10105
+ "name": "labelFontClass",
10106
+ "description": "Returns the label font class based on layout and visibility state.",
10107
+ "privacy": "private",
10020
10108
  "return": {
10021
10109
  "type": {
10022
- "text": "void"
10110
+ "text": "string"
10023
10111
  }
10024
10112
  },
10025
- "inheritedFrom": {
10026
- "name": "BaseInput",
10027
- "module": "components/input/src/base-input.js"
10028
- }
10113
+ "readonly": true
10029
10114
  },
10030
10115
  {
10031
- "kind": "method",
10032
- "name": "handleClickClear",
10033
- "description": "Handles event of clearing input content by clicking the X icon.",
10116
+ "kind": "field",
10117
+ "name": "inputFontClass",
10118
+ "description": "Returns the input font class based on layout and visibility state.",
10034
10119
  "privacy": "private",
10035
10120
  "return": {
10036
10121
  "type": {
10037
- "text": "void"
10122
+ "text": "string"
10038
10123
  }
10039
10124
  },
10040
- "inheritedFrom": {
10041
- "name": "BaseInput",
10042
- "module": "components/input/src/base-input.js"
10043
- }
10125
+ "readonly": true
10044
10126
  },
10045
10127
  {
10046
- "kind": "method",
10047
- "name": "handleInput",
10048
- "parameters": [
10049
- {
10050
- "name": "event",
10051
- "description": "The input event.",
10052
- "type": {
10053
- "text": "Event"
10054
- }
10055
- }
10056
- ],
10128
+ "kind": "field",
10129
+ "name": "commonLabelClasses",
10130
+ "description": "Returns classmap configuration for html5 input labels in all layouts.",
10057
10131
  "privacy": "private",
10058
10132
  "return": {
10059
10133
  "type": {
10060
- "text": "void"
10134
+ "text": "Record<string, boolean>"
10061
10135
  }
10062
10136
  },
10063
- "inheritedFrom": {
10064
- "name": "BaseInput",
10065
- "module": "components/input/src/base-input.js"
10066
- }
10137
+ "readonly": true
10067
10138
  },
10068
10139
  {
10069
- "kind": "method",
10070
- "name": "handleFocusin",
10071
- "description": "Function to support",
10140
+ "kind": "field",
10141
+ "name": "commonInputClasses",
10142
+ "description": "Returns classmap configuration for html5 inputs in all layouts.",
10072
10143
  "privacy": "private",
10073
10144
  "return": {
10074
10145
  "type": {
10075
- "text": "void"
10146
+ "text": "Record<string, boolean>"
10076
10147
  }
10077
10148
  },
10078
- "inheritedFrom": {
10079
- "name": "BaseInput",
10080
- "module": "components/input/src/base-input.js"
10081
- }
10149
+ "readonly": true
10082
10150
  },
10083
10151
  {
10084
- "kind": "method",
10085
- "name": "handleFocusout",
10086
- "description": "Function to support",
10152
+ "kind": "field",
10153
+ "name": "commonDisplayValueWrapperClasses",
10154
+ "description": "Common display value wrapper classes.",
10087
10155
  "privacy": "private",
10088
10156
  "return": {
10089
10157
  "type": {
10090
- "text": "void"
10158
+ "text": "Record<string, boolean>"
10091
10159
  }
10092
10160
  },
10093
- "inheritedFrom": {
10094
- "name": "BaseInput",
10095
- "module": "components/input/src/base-input.js"
10096
- }
10161
+ "readonly": true
10097
10162
  },
10098
10163
  {
10099
- "kind": "method",
10100
- "name": "handleBlur",
10101
- "description": "Function to support",
10164
+ "kind": "field",
10165
+ "name": "legacyInputClasses",
10166
+ "description": "Returns classmap configuration for html5 inputs in each layout.",
10102
10167
  "privacy": "private",
10103
10168
  "return": {
10104
10169
  "type": {
10105
- "text": "void"
10170
+ "text": "object"
10106
10171
  }
10107
10172
  },
10108
- "inheritedFrom": {
10109
- "name": "BaseInput",
10110
- "module": "components/input/src/base-input.js"
10111
- }
10173
+ "readonly": true
10112
10174
  },
10113
10175
  {
10114
- "kind": "method",
10115
- "name": "getActiveElement",
10116
- "parameters": [
10117
- {
10118
- "name": "root",
10119
- "default": "document",
10120
- "description": "Element to check for focus.",
10121
- "type": {
10122
- "text": "Object"
10123
- }
10124
- }
10125
- ],
10126
- "description": "Returns focused element, even if it's in the shadow DOM.",
10176
+ "kind": "field",
10177
+ "name": "commonWrapperClasses",
10178
+ "description": "Returns classmap configuration for wrapper elements in each layout.",
10127
10179
  "privacy": "private",
10128
10180
  "return": {
10129
10181
  "type": {
10130
- "text": "Object"
10182
+ "text": "object"
10131
10183
  }
10132
10184
  },
10133
- "inheritedFrom": {
10134
- "name": "BaseInput",
10135
- "module": "components/input/src/base-input.js"
10136
- }
10185
+ "readonly": true
10137
10186
  },
10138
10187
  {
10139
- "kind": "method",
10140
- "name": "setActiveDescendant",
10141
- "parameters": [
10142
- {
10143
- "name": "element",
10144
- "description": "The element to set as the active descendant, or null to clear.",
10145
- "type": {
10146
- "text": "HTMLElement|null"
10147
- }
10148
- }
10149
- ],
10150
- "description": "Sets the active descendant element for accessibility.\nUses ariaActiveDescendantElement to cross shadow DOM boundaries.\nThis function is used in components that contain `auro-input` to set the active descendant.",
10188
+ "kind": "field",
10189
+ "name": "helpTextClasses",
10190
+ "description": "Returns classmap configuration for helpText elements in each layout.",
10151
10191
  "privacy": "private",
10152
10192
  "return": {
10153
10193
  "type": {
10154
- "text": "void"
10194
+ "text": "object"
10155
10195
  }
10156
10196
  },
10157
- "inheritedFrom": {
10158
- "name": "BaseInput",
10159
- "module": "components/input/src/base-input.js"
10160
- }
10197
+ "readonly": true
10161
10198
  },
10162
10199
  {
10163
10200
  "kind": "method",
10164
- "name": "validate",
10201
+ "name": "register",
10202
+ "static": true,
10165
10203
  "parameters": [
10166
10204
  {
10167
- "name": "force",
10168
- "default": "false",
10169
- "description": "Whether to force validation.",
10205
+ "name": "name",
10206
+ "default": "\"auro-input\"",
10207
+ "description": "The name of the element that you want to register.",
10170
10208
  "optional": true,
10171
10209
  "type": {
10172
- "text": "boolean"
10210
+ "text": "string"
10173
10211
  }
10174
10212
  }
10175
10213
  ],
10176
- "description": "Validates value.",
10177
- "inheritedFrom": {
10178
- "name": "BaseInput",
10179
- "module": "components/input/src/base-input.js"
10180
- }
10214
+ "description": "This will register this element with the browser."
10181
10215
  },
10182
10216
  {
10183
10217
  "kind": "method",
10184
- "name": "reset",
10185
- "description": "Resets component to initial state, including resetting the touched state and validity.",
10218
+ "name": "hasTypeIcon",
10219
+ "description": "Function to determine if the input is meant to render an icon visualizing the input type.",
10220
+ "privacy": "private",
10186
10221
  "return": {
10187
10222
  "type": {
10188
- "text": "void"
10223
+ "text": "boolean"
10189
10224
  }
10190
- },
10191
- "inheritedFrom": {
10192
- "name": "BaseInput",
10193
- "module": "components/input/src/base-input.js"
10194
10225
  }
10195
10226
  },
10196
10227
  {
10197
10228
  "kind": "method",
10198
- "name": "clear",
10199
- "description": "Clears the input value.",
10200
- "inheritedFrom": {
10201
- "name": "BaseInput",
10202
- "module": "components/input/src/base-input.js"
10229
+ "name": "checkDisplayValueSlotChange",
10230
+ "description": "Function to determine if there is any displayValue content to render.",
10231
+ "privacy": "private",
10232
+ "return": {
10233
+ "type": {
10234
+ "text": "void"
10235
+ }
10203
10236
  }
10204
10237
  },
10205
10238
  {
10206
10239
  "kind": "method",
10207
- "name": "configureDataForType",
10208
- "description": "Sets configuration data used elsewhere based on the `type` attribute.",
10240
+ "name": "renderValidationErrorIconHtml",
10241
+ "description": "Returns HTML for the validation error icon.",
10209
10242
  "privacy": "private",
10210
10243
  "return": {
10211
10244
  "type": {
10212
- "text": "void"
10245
+ "text": "html"
10213
10246
  }
10214
- },
10215
- "inheritedFrom": {
10216
- "name": "BaseInput",
10217
- "module": "components/input/src/base-input.js"
10218
10247
  }
10219
10248
  },
10220
10249
  {
10221
10250
  "kind": "method",
10222
- "name": "getInputType",
10251
+ "name": "renderHtmlInput",
10223
10252
  "parameters": [
10224
10253
  {
10225
- "name": "type",
10226
- "description": "Value entered into component prop.",
10254
+ "name": "useLegacyHiddenState",
10255
+ "default": "false",
10256
+ "description": "If true, the input will be visually hidden when not focused and has no value.",
10257
+ "optional": true,
10258
+ "type": {
10259
+ "text": "boolean"
10260
+ }
10261
+ }
10262
+ ],
10263
+ "description": "Returns HTML for the HTML5 input element.",
10264
+ "privacy": "private",
10265
+ "return": {
10266
+ "type": {
10267
+ "text": "html"
10268
+ }
10269
+ }
10270
+ },
10271
+ {
10272
+ "kind": "method",
10273
+ "name": "renderHtmlActionClear",
10274
+ "description": "Returns HTML for the clear action button.",
10275
+ "privacy": "private",
10276
+ "return": {
10277
+ "type": {
10278
+ "text": "html"
10279
+ }
10280
+ }
10281
+ },
10282
+ {
10283
+ "kind": "method",
10284
+ "name": "renderHtmlNotificationPassword",
10285
+ "description": "Returns HTML for the show password button.",
10286
+ "privacy": "private",
10287
+ "return": {
10288
+ "type": {
10289
+ "text": "html"
10290
+ }
10291
+ }
10292
+ },
10293
+ {
10294
+ "kind": "method",
10295
+ "name": "renderHtmlTypeIcon",
10296
+ "description": "Returns HTML for the input type icon.",
10297
+ "privacy": "private",
10298
+ "return": {
10299
+ "type": {
10300
+ "text": "html"
10301
+ }
10302
+ }
10303
+ },
10304
+ {
10305
+ "kind": "method",
10306
+ "name": "renderHtmlHelpText",
10307
+ "description": "Returns HTML for the help text and error message.",
10308
+ "privacy": "private",
10309
+ "return": {
10310
+ "type": {
10311
+ "text": "html"
10312
+ }
10313
+ }
10314
+ },
10315
+ {
10316
+ "kind": "method",
10317
+ "name": "renderLayoutClassic",
10318
+ "description": "Returns HTML for the classic layout.",
10319
+ "privacy": "private",
10320
+ "return": {
10321
+ "type": {
10322
+ "text": "TemplateResult"
10323
+ }
10324
+ }
10325
+ },
10326
+ {
10327
+ "kind": "method",
10328
+ "name": "renderLayoutEmphasized",
10329
+ "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".",
10330
+ "privacy": "private",
10331
+ "return": {
10332
+ "type": {
10333
+ "text": "html"
10334
+ }
10335
+ }
10336
+ },
10337
+ {
10338
+ "kind": "method",
10339
+ "name": "renderLayoutSnowflake",
10340
+ "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".",
10341
+ "privacy": "private",
10342
+ "return": {
10343
+ "type": {
10344
+ "text": "html"
10345
+ }
10346
+ }
10347
+ },
10348
+ {
10349
+ "kind": "method",
10350
+ "name": "renderLayout",
10351
+ "parameters": [
10352
+ {
10353
+ "name": "ForcedLayout",
10354
+ "description": "Used to force a specific layout, pass in the layout name to use.",
10355
+ "optional": true,
10227
10356
  "type": {
10228
10357
  "text": "string"
10229
10358
  }
10230
10359
  }
10231
10360
  ],
10232
- "description": "Validates against list of supported this.allowedInputTypes; return type=text if invalid request.",
10361
+ "description": "Logic to determine the layout of the component.",
10233
10362
  "privacy": "private",
10234
10363
  "return": {
10235
10364
  "type": {
10236
- "text": "string"
10365
+ "text": "void"
10237
10366
  }
10367
+ }
10368
+ },
10369
+ {
10370
+ "kind": "field",
10371
+ "name": "buttonTag",
10372
+ "privacy": "private"
10373
+ },
10374
+ {
10375
+ "kind": "field",
10376
+ "name": "hasDisplayValueContent",
10377
+ "type": {
10378
+ "text": "boolean"
10238
10379
  },
10380
+ "privacy": "private",
10381
+ "default": "false"
10382
+ },
10383
+ {
10384
+ "kind": "field",
10385
+ "name": "helpTextTag",
10386
+ "privacy": "private"
10387
+ },
10388
+ {
10389
+ "kind": "field",
10390
+ "name": "iconTag",
10391
+ "privacy": "private"
10392
+ },
10393
+ {
10394
+ "kind": "field",
10395
+ "name": "clearButtonRef",
10396
+ "privacy": "private"
10397
+ },
10398
+ {
10399
+ "kind": "field",
10400
+ "name": "shadowRootOptions",
10401
+ "static": true,
10402
+ "readonly": true,
10239
10403
  "inheritedFrom": {
10240
10404
  "name": "BaseInput",
10241
10405
  "module": "components/input/src/base-input.js"
@@ -10243,12 +10407,12 @@
10243
10407
  },
10244
10408
  {
10245
10409
  "kind": "method",
10246
- "name": "getHelpText",
10247
- "description": "Determines default help text string.",
10410
+ "name": "_initializeDefaults",
10411
+ "description": "Internal Defaults.",
10248
10412
  "privacy": "private",
10249
10413
  "return": {
10250
10414
  "type": {
10251
- "text": "string"
10415
+ "text": "void"
10252
10416
  }
10253
10417
  },
10254
10418
  "inheritedFrom": {
@@ -10258,30 +10422,37 @@
10258
10422
  },
10259
10423
  {
10260
10424
  "kind": "method",
10261
- "name": "handleClickShowPassword",
10262
- "description": "Function to support show-password feature.",
10263
- "privacy": "private",
10425
+ "name": "patchInputEvent",
10426
+ "parameters": [
10427
+ {
10428
+ "name": "input",
10429
+ "description": "The input element to patch.",
10430
+ "type": {
10431
+ "text": "HTMLInputElement"
10432
+ }
10433
+ }
10434
+ ],
10435
+ "description": "Patches the input element to dispatch an 'input' event whenever its value is set programmatically.\nThis ensures that changes to the input's value are consistently communicated, even if not triggered by user input.",
10264
10436
  "return": {
10265
10437
  "type": {
10266
10438
  "text": "void"
10267
10439
  }
10268
10440
  },
10441
+ "privacy": "private",
10269
10442
  "inheritedFrom": {
10270
10443
  "name": "BaseInput",
10271
10444
  "module": "components/input/src/base-input.js"
10272
10445
  }
10273
10446
  },
10274
10447
  {
10275
- "kind": "field",
10276
- "name": "placeholderStr",
10277
- "description": "Support placeholder text.",
10448
+ "kind": "method",
10449
+ "name": "setCustomHelpTextMessage",
10278
10450
  "privacy": "private",
10279
10451
  "return": {
10280
10452
  "type": {
10281
10453
  "text": "void"
10282
10454
  }
10283
10455
  },
10284
- "readonly": true,
10285
10456
  "inheritedFrom": {
10286
10457
  "name": "BaseInput",
10287
10458
  "module": "components/input/src/base-input.js"
@@ -10289,12 +10460,11 @@
10289
10460
  },
10290
10461
  {
10291
10462
  "kind": "method",
10292
- "name": "defineInputIcon",
10293
- "description": "Defines placement of input icon based on type, used with classMap.",
10463
+ "name": "notifyValidityChange",
10294
10464
  "privacy": "private",
10295
10465
  "return": {
10296
10466
  "type": {
10297
- "text": "boolean"
10467
+ "text": "void"
10298
10468
  }
10299
10469
  },
10300
10470
  "inheritedFrom": {
@@ -10304,12 +10474,12 @@
10304
10474
  },
10305
10475
  {
10306
10476
  "kind": "method",
10307
- "name": "defineLabelPadding",
10308
- "description": "Defines padding of input label based on type, used with classMap.",
10477
+ "name": "configureAutoFormatting",
10478
+ "description": "Sets up IMasks and logic based on auto-formatting requirements.",
10309
10479
  "privacy": "private",
10310
10480
  "return": {
10311
10481
  "type": {
10312
- "text": "boolean"
10482
+ "text": "void"
10313
10483
  }
10314
10484
  },
10315
10485
  "inheritedFrom": {
@@ -10319,12 +10489,11 @@
10319
10489
  },
10320
10490
  {
10321
10491
  "kind": "method",
10322
- "name": "processCreditCard",
10323
- "description": "Function to support credit-card feature type.",
10492
+ "name": "definePattern",
10324
10493
  "privacy": "private",
10325
10494
  "return": {
10326
10495
  "type": {
10327
- "text": "void"
10496
+ "text": "string"
10328
10497
  }
10329
10498
  },
10330
10499
  "inheritedFrom": {
@@ -10334,12 +10503,12 @@
10334
10503
  },
10335
10504
  {
10336
10505
  "kind": "method",
10337
- "name": "matchInputValueToCreditCard",
10338
- "description": "Function to support credit-card feature type.",
10506
+ "name": "notifyValueChanged",
10507
+ "description": "Sends event notifying that the input has changed it's value.",
10339
10508
  "privacy": "private",
10340
10509
  "return": {
10341
10510
  "type": {
10342
- "text": "object"
10511
+ "text": "void"
10343
10512
  }
10344
10513
  },
10345
10514
  "inheritedFrom": {
@@ -10348,237 +10517,273 @@
10348
10517
  }
10349
10518
  },
10350
10519
  {
10351
- "kind": "field",
10352
- "name": "a11yRole",
10353
- "privacy": "public",
10354
- "type": {
10355
- "text": "string"
10520
+ "kind": "method",
10521
+ "name": "handleClick",
10522
+ "description": "Handles clicking on the auro-input anywhere outside of the HTML5 input and still moving focus in.",
10523
+ "privacy": "private",
10524
+ "return": {
10525
+ "type": {
10526
+ "text": "void"
10527
+ }
10356
10528
  },
10357
- "description": "The value for the role attribute.",
10358
- "attribute": "a11yRole",
10359
- "reflects": true,
10360
10529
  "inheritedFrom": {
10361
10530
  "name": "BaseInput",
10362
10531
  "module": "components/input/src/base-input.js"
10363
10532
  }
10364
10533
  },
10365
10534
  {
10366
- "kind": "field",
10367
- "name": "a11yControls",
10368
- "privacy": "public",
10369
- "type": {
10370
- "text": "string"
10535
+ "kind": "method",
10536
+ "name": "focus",
10537
+ "description": "Function to set element focus.",
10538
+ "return": {
10539
+ "type": {
10540
+ "text": "void"
10541
+ }
10371
10542
  },
10372
- "description": "The value for the aria-controls attribute.",
10373
- "attribute": "a11yControls",
10374
- "reflects": true,
10375
10543
  "inheritedFrom": {
10376
10544
  "name": "BaseInput",
10377
10545
  "module": "components/input/src/base-input.js"
10378
10546
  }
10379
10547
  },
10380
10548
  {
10381
- "kind": "field",
10382
- "name": "a11yExpanded",
10383
- "privacy": "public",
10384
- "type": {
10385
- "text": "boolean"
10386
- },
10387
- "description": "The value for the aria-expanded attribute.",
10388
- "attribute": "a11yExpanded",
10389
- "reflects": true,
10549
+ "kind": "method",
10550
+ "name": "handleClickClear",
10551
+ "description": "Handles event of clearing input content by clicking the X icon.",
10552
+ "privacy": "private",
10553
+ "return": {
10554
+ "type": {
10555
+ "text": "void"
10556
+ }
10557
+ },
10390
10558
  "inheritedFrom": {
10391
10559
  "name": "BaseInput",
10392
10560
  "module": "components/input/src/base-input.js"
10393
10561
  }
10394
10562
  },
10395
10563
  {
10396
- "kind": "field",
10397
- "name": "a11yActivedescendant",
10398
- "privacy": "public",
10399
- "type": {
10400
- "text": "string"
10564
+ "kind": "method",
10565
+ "name": "handleInput",
10566
+ "parameters": [
10567
+ {
10568
+ "name": "event",
10569
+ "description": "The input event.",
10570
+ "type": {
10571
+ "text": "Event"
10572
+ }
10573
+ }
10574
+ ],
10575
+ "privacy": "private",
10576
+ "return": {
10577
+ "type": {
10578
+ "text": "void"
10579
+ }
10401
10580
  },
10402
- "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.",
10403
- "attribute": "a11yActivedescendant",
10404
- "reflects": true,
10405
10581
  "inheritedFrom": {
10406
10582
  "name": "BaseInput",
10407
10583
  "module": "components/input/src/base-input.js"
10408
10584
  }
10409
10585
  },
10410
10586
  {
10411
- "kind": "field",
10412
- "name": "activeLabel",
10413
- "privacy": "public",
10414
- "type": {
10415
- "text": "boolean"
10587
+ "kind": "method",
10588
+ "name": "handleFocusin",
10589
+ "description": "Function to support",
10590
+ "privacy": "private",
10591
+ "return": {
10592
+ "type": {
10593
+ "text": "void"
10594
+ }
10416
10595
  },
10417
- "description": "If set, the label will remain fixed in the active position.",
10418
- "attribute": "activeLabel",
10419
- "reflects": true,
10420
10596
  "inheritedFrom": {
10421
10597
  "name": "BaseInput",
10422
10598
  "module": "components/input/src/base-input.js"
10423
10599
  }
10424
10600
  },
10425
10601
  {
10426
- "kind": "field",
10427
- "name": "appearance",
10428
- "privacy": "public",
10429
- "type": {
10430
- "text": "'default' | 'inverse'"
10602
+ "kind": "method",
10603
+ "name": "handleFocusout",
10604
+ "description": "Function to support",
10605
+ "privacy": "private",
10606
+ "return": {
10607
+ "type": {
10608
+ "text": "void"
10609
+ }
10431
10610
  },
10432
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
10433
- "default": "'default'",
10434
- "attribute": "appearance",
10435
- "reflects": true,
10436
10611
  "inheritedFrom": {
10437
10612
  "name": "BaseInput",
10438
10613
  "module": "components/input/src/base-input.js"
10439
10614
  }
10440
10615
  },
10441
10616
  {
10442
- "kind": "field",
10443
- "name": "autocapitalize",
10444
- "privacy": "public",
10445
- "type": {
10446
- "text": "string"
10617
+ "kind": "method",
10618
+ "name": "handleBlur",
10619
+ "description": "Function to support",
10620
+ "privacy": "private",
10621
+ "return": {
10622
+ "type": {
10623
+ "text": "void"
10624
+ }
10447
10625
  },
10448
- "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].",
10449
- "attribute": "autocapitalize",
10450
- "reflects": true,
10451
10626
  "inheritedFrom": {
10452
10627
  "name": "BaseInput",
10453
10628
  "module": "components/input/src/base-input.js"
10454
10629
  }
10455
10630
  },
10456
10631
  {
10457
- "kind": "field",
10458
- "name": "autocomplete",
10459
- "privacy": "public",
10460
- "type": {
10461
- "text": "string"
10632
+ "kind": "method",
10633
+ "name": "getActiveElement",
10634
+ "parameters": [
10635
+ {
10636
+ "name": "root",
10637
+ "default": "document",
10638
+ "description": "Element to check for focus.",
10639
+ "type": {
10640
+ "text": "Object"
10641
+ }
10642
+ }
10643
+ ],
10644
+ "description": "Returns focused element, even if it's in the shadow DOM.",
10645
+ "privacy": "private",
10646
+ "return": {
10647
+ "type": {
10648
+ "text": "Object"
10649
+ }
10462
10650
  },
10463
- "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
10464
- "attribute": "autocomplete",
10465
- "reflects": true,
10466
10651
  "inheritedFrom": {
10467
10652
  "name": "BaseInput",
10468
10653
  "module": "components/input/src/base-input.js"
10469
10654
  }
10470
10655
  },
10471
10656
  {
10472
- "kind": "field",
10473
- "name": "autocorrect",
10474
- "privacy": "public",
10475
- "type": {
10476
- "text": "string"
10657
+ "kind": "method",
10658
+ "name": "setActiveDescendant",
10659
+ "parameters": [
10660
+ {
10661
+ "name": "element",
10662
+ "description": "The element to set as the active descendant, or null to clear.",
10663
+ "type": {
10664
+ "text": "HTMLElement|null"
10665
+ }
10666
+ }
10667
+ ],
10668
+ "description": "Sets the active descendant element for accessibility.\nUses ariaActiveDescendantElement to cross shadow DOM boundaries.\nThis function is used in components that contain `auro-input` to set the active descendant.",
10669
+ "privacy": "private",
10670
+ "return": {
10671
+ "type": {
10672
+ "text": "void"
10673
+ }
10477
10674
  },
10478
- "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.",
10479
- "attribute": "autocorrect",
10480
- "reflects": true,
10481
10675
  "inheritedFrom": {
10482
10676
  "name": "BaseInput",
10483
10677
  "module": "components/input/src/base-input.js"
10484
10678
  }
10485
10679
  },
10486
10680
  {
10487
- "kind": "field",
10488
- "name": "customValidityTypeEmail",
10489
- "privacy": "public",
10490
- "type": {
10491
- "text": "string"
10492
- },
10493
- "description": "Custom help text message for email type validity.",
10494
- "attribute": "customValidityTypeEmail",
10681
+ "kind": "method",
10682
+ "name": "validate",
10683
+ "parameters": [
10684
+ {
10685
+ "name": "force",
10686
+ "default": "false",
10687
+ "description": "Whether to force validation.",
10688
+ "optional": true,
10689
+ "type": {
10690
+ "text": "boolean"
10691
+ }
10692
+ }
10693
+ ],
10694
+ "description": "Validates value.",
10495
10695
  "inheritedFrom": {
10496
10696
  "name": "BaseInput",
10497
10697
  "module": "components/input/src/base-input.js"
10498
10698
  }
10499
10699
  },
10500
10700
  {
10501
- "kind": "field",
10502
- "name": "disabled",
10503
- "privacy": "public",
10504
- "type": {
10505
- "text": "boolean"
10701
+ "kind": "method",
10702
+ "name": "reset",
10703
+ "description": "Resets component to initial state, including resetting the touched state and validity.",
10704
+ "return": {
10705
+ "type": {
10706
+ "text": "void"
10707
+ }
10506
10708
  },
10507
- "description": "If set, disables the input.",
10508
- "attribute": "disabled",
10509
- "reflects": true,
10510
10709
  "inheritedFrom": {
10511
10710
  "name": "BaseInput",
10512
10711
  "module": "components/input/src/base-input.js"
10513
10712
  }
10514
10713
  },
10515
10714
  {
10516
- "kind": "field",
10517
- "name": "dvInputOnly",
10518
- "privacy": "public",
10519
- "type": {
10520
- "text": "boolean"
10521
- },
10522
- "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.",
10523
- "attribute": "dvInputOnly",
10524
- "reflects": true,
10715
+ "kind": "method",
10716
+ "name": "clear",
10717
+ "description": "Clears the input value.",
10525
10718
  "inheritedFrom": {
10526
10719
  "name": "BaseInput",
10527
10720
  "module": "components/input/src/base-input.js"
10528
10721
  }
10529
10722
  },
10530
10723
  {
10531
- "kind": "field",
10532
- "name": "error",
10533
- "privacy": "public",
10534
- "type": {
10535
- "text": "string"
10724
+ "kind": "method",
10725
+ "name": "configureDataForType",
10726
+ "description": "Sets configuration data used elsewhere based on the `type` attribute.",
10727
+ "privacy": "private",
10728
+ "return": {
10729
+ "type": {
10730
+ "text": "void"
10731
+ }
10536
10732
  },
10537
- "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.",
10538
- "attribute": "error",
10539
- "reflects": true,
10540
10733
  "inheritedFrom": {
10541
10734
  "name": "BaseInput",
10542
10735
  "module": "components/input/src/base-input.js"
10543
10736
  }
10544
10737
  },
10545
10738
  {
10546
- "kind": "field",
10547
- "name": "errorMessage",
10548
- "privacy": "public",
10549
- "type": {
10550
- "text": "string"
10739
+ "kind": "method",
10740
+ "name": "getInputType",
10741
+ "parameters": [
10742
+ {
10743
+ "name": "type",
10744
+ "description": "Value entered into component prop.",
10745
+ "type": {
10746
+ "text": "string"
10747
+ }
10748
+ }
10749
+ ],
10750
+ "description": "Validates against list of supported this.allowedInputTypes; return type=text if invalid request.",
10751
+ "privacy": "private",
10752
+ "return": {
10753
+ "type": {
10754
+ "text": "string"
10755
+ }
10551
10756
  },
10552
- "description": "Contains the help text message for the current validity error.",
10553
- "attribute": "errorMessage",
10554
10757
  "inheritedFrom": {
10555
10758
  "name": "BaseInput",
10556
10759
  "module": "components/input/src/base-input.js"
10557
10760
  }
10558
10761
  },
10559
10762
  {
10560
- "kind": "field",
10561
- "name": "format",
10562
- "privacy": "public",
10563
- "type": {
10564
- "text": "string"
10763
+ "kind": "method",
10764
+ "name": "getHelpText",
10765
+ "description": "Determines default help text string.",
10766
+ "privacy": "private",
10767
+ "return": {
10768
+ "type": {
10769
+ "text": "string"
10770
+ }
10565
10771
  },
10566
- "description": "Specifies the input mask format.",
10567
- "attribute": "format",
10568
- "reflects": true,
10569
10772
  "inheritedFrom": {
10570
10773
  "name": "BaseInput",
10571
10774
  "module": "components/input/src/base-input.js"
10572
10775
  }
10573
10776
  },
10574
10777
  {
10575
- "kind": "field",
10576
- "name": "hasFocus",
10577
- "privacy": "public",
10578
- "type": {
10579
- "text": "boolean"
10778
+ "kind": "method",
10779
+ "name": "handleClickShowPassword",
10780
+ "description": "Function to support show-password feature.",
10781
+ "privacy": "private",
10782
+ "return": {
10783
+ "type": {
10784
+ "text": "void"
10785
+ }
10580
10786
  },
10581
- "description": "Flag to indicate if the input currently has focus.",
10582
10787
  "inheritedFrom": {
10583
10788
  "name": "BaseInput",
10584
10789
  "module": "components/input/src/base-input.js"
@@ -10586,69 +10791,90 @@
10586
10791
  },
10587
10792
  {
10588
10793
  "kind": "field",
10589
- "name": "hasValue",
10590
- "privacy": "public",
10591
- "type": {
10592
- "text": "boolean"
10794
+ "name": "placeholderStr",
10795
+ "description": "Support placeholder text.",
10796
+ "privacy": "private",
10797
+ "return": {
10798
+ "type": {
10799
+ "text": "void"
10800
+ }
10593
10801
  },
10594
- "description": "Flag to indicate if the input currently has value.",
10802
+ "readonly": true,
10595
10803
  "inheritedFrom": {
10596
10804
  "name": "BaseInput",
10597
10805
  "module": "components/input/src/base-input.js"
10598
10806
  }
10599
10807
  },
10600
10808
  {
10601
- "kind": "field",
10602
- "name": "hideLabelVisually",
10809
+ "kind": "method",
10810
+ "name": "defineInputIcon",
10811
+ "description": "Defines placement of input icon based on type, used with classMap.",
10603
10812
  "privacy": "private",
10604
- "type": {
10605
- "text": "boolean"
10813
+ "return": {
10814
+ "type": {
10815
+ "text": "boolean"
10816
+ }
10606
10817
  },
10607
- "description": "If set, the label will be hidden visually but still accessible to assistive technologies.",
10608
- "attribute": "hideLabelVisually",
10609
- "reflects": true,
10610
10818
  "inheritedFrom": {
10611
10819
  "name": "BaseInput",
10612
10820
  "module": "components/input/src/base-input.js"
10613
10821
  }
10614
10822
  },
10615
10823
  {
10616
- "kind": "field",
10617
- "name": "icon",
10618
- "privacy": "public",
10619
- "type": {
10620
- "text": "boolean"
10824
+ "kind": "method",
10825
+ "name": "defineLabelPadding",
10826
+ "description": "Defines padding of input label based on type, used with classMap.",
10827
+ "privacy": "private",
10828
+ "return": {
10829
+ "type": {
10830
+ "text": "boolean"
10831
+ }
10621
10832
  },
10622
- "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.",
10623
- "attribute": "icon",
10624
- "reflects": true,
10625
10833
  "inheritedFrom": {
10626
10834
  "name": "BaseInput",
10627
10835
  "module": "components/input/src/base-input.js"
10628
10836
  }
10629
10837
  },
10630
10838
  {
10631
- "kind": "field",
10632
- "name": "id",
10633
- "privacy": "public",
10634
- "type": {
10635
- "text": "string"
10839
+ "kind": "method",
10840
+ "name": "processCreditCard",
10841
+ "description": "Function to support credit-card feature type.",
10842
+ "privacy": "private",
10843
+ "return": {
10844
+ "type": {
10845
+ "text": "void"
10846
+ }
10636
10847
  },
10637
- "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
10638
- "attribute": "id",
10639
10848
  "inheritedFrom": {
10640
10849
  "name": "BaseInput",
10641
10850
  "module": "components/input/src/base-input.js"
10642
10851
  }
10643
10852
  },
10644
10853
  {
10645
- "kind": "field",
10646
- "name": "inputId",
10854
+ "kind": "method",
10855
+ "name": "matchInputValueToCreditCard",
10856
+ "description": "Function to support credit-card feature type.",
10647
10857
  "privacy": "private",
10858
+ "return": {
10859
+ "type": {
10860
+ "text": "object"
10861
+ }
10862
+ },
10863
+ "inheritedFrom": {
10864
+ "name": "BaseInput",
10865
+ "module": "components/input/src/base-input.js"
10866
+ }
10867
+ },
10868
+ {
10869
+ "kind": "field",
10870
+ "name": "a11yRole",
10871
+ "privacy": "public",
10648
10872
  "type": {
10649
10873
  "text": "string"
10650
10874
  },
10651
- "description": "The id for input node.",
10875
+ "description": "The value for the role attribute.",
10876
+ "attribute": "a11yRole",
10877
+ "reflects": true,
10652
10878
  "inheritedFrom": {
10653
10879
  "name": "BaseInput",
10654
10880
  "module": "components/input/src/base-input.js"
@@ -10656,13 +10882,13 @@
10656
10882
  },
10657
10883
  {
10658
10884
  "kind": "field",
10659
- "name": "inputmode",
10885
+ "name": "a11yControls",
10660
10886
  "privacy": "public",
10661
10887
  "type": {
10662
10888
  "text": "string"
10663
10889
  },
10664
- "description": "Exposes inputmode attribute for input.",
10665
- "attribute": "inputmode",
10890
+ "description": "The value for the aria-controls attribute.",
10891
+ "attribute": "a11yControls",
10666
10892
  "reflects": true,
10667
10893
  "inheritedFrom": {
10668
10894
  "name": "BaseInput",
@@ -10671,13 +10897,13 @@
10671
10897
  },
10672
10898
  {
10673
10899
  "kind": "field",
10674
- "name": "lang",
10900
+ "name": "a11yExpanded",
10675
10901
  "privacy": "public",
10676
10902
  "type": {
10677
- "text": "string"
10903
+ "text": "boolean"
10678
10904
  },
10679
- "description": "Defines the language of an element.",
10680
- "attribute": "lang",
10905
+ "description": "The value for the aria-expanded attribute.",
10906
+ "attribute": "a11yExpanded",
10681
10907
  "reflects": true,
10682
10908
  "inheritedFrom": {
10683
10909
  "name": "BaseInput",
@@ -10686,13 +10912,14 @@
10686
10912
  },
10687
10913
  {
10688
10914
  "kind": "field",
10689
- "name": "max",
10915
+ "name": "a11yActivedescendant",
10690
10916
  "privacy": "public",
10691
10917
  "type": {
10692
10918
  "text": "string"
10693
10919
  },
10694
- "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.",
10695
- "attribute": "max",
10920
+ "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.",
10921
+ "attribute": "a11yActivedescendant",
10922
+ "reflects": true,
10696
10923
  "inheritedFrom": {
10697
10924
  "name": "BaseInput",
10698
10925
  "module": "components/input/src/base-input.js"
@@ -10700,13 +10927,13 @@
10700
10927
  },
10701
10928
  {
10702
10929
  "kind": "field",
10703
- "name": "maxLength",
10930
+ "name": "activeLabel",
10704
10931
  "privacy": "public",
10705
10932
  "type": {
10706
- "text": "number"
10933
+ "text": "boolean"
10707
10934
  },
10708
- "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.",
10709
- "attribute": "maxLength",
10935
+ "description": "If set, the label will remain fixed in the active position.",
10936
+ "attribute": "activeLabel",
10710
10937
  "reflects": true,
10711
10938
  "inheritedFrom": {
10712
10939
  "name": "BaseInput",
@@ -10715,13 +10942,15 @@
10715
10942
  },
10716
10943
  {
10717
10944
  "kind": "field",
10718
- "name": "min",
10945
+ "name": "appearance",
10719
10946
  "privacy": "public",
10720
10947
  "type": {
10721
- "text": "string"
10948
+ "text": "'default' | 'inverse'"
10722
10949
  },
10723
- "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.",
10724
- "attribute": "min",
10950
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
10951
+ "default": "'default'",
10952
+ "attribute": "appearance",
10953
+ "reflects": true,
10725
10954
  "inheritedFrom": {
10726
10955
  "name": "BaseInput",
10727
10956
  "module": "components/input/src/base-input.js"
@@ -10729,13 +10958,13 @@
10729
10958
  },
10730
10959
  {
10731
10960
  "kind": "field",
10732
- "name": "minLength",
10961
+ "name": "autocapitalize",
10733
10962
  "privacy": "public",
10734
10963
  "type": {
10735
- "text": "number"
10964
+ "text": "string"
10736
10965
  },
10737
- "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.",
10738
- "attribute": "minLength",
10966
+ "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].",
10967
+ "attribute": "autocapitalize",
10739
10968
  "reflects": true,
10740
10969
  "inheritedFrom": {
10741
10970
  "name": "BaseInput",
@@ -10744,13 +10973,13 @@
10744
10973
  },
10745
10974
  {
10746
10975
  "kind": "field",
10747
- "name": "name",
10976
+ "name": "autocomplete",
10748
10977
  "privacy": "public",
10749
10978
  "type": {
10750
10979
  "text": "string"
10751
10980
  },
10752
- "description": "Populates the `name` attribute on the input.",
10753
- "attribute": "name",
10981
+ "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
10982
+ "attribute": "autocomplete",
10754
10983
  "reflects": true,
10755
10984
  "inheritedFrom": {
10756
10985
  "name": "BaseInput",
@@ -10759,13 +10988,13 @@
10759
10988
  },
10760
10989
  {
10761
10990
  "kind": "field",
10762
- "name": "nested",
10991
+ "name": "autocorrect",
10763
10992
  "privacy": "public",
10764
10993
  "type": {
10765
- "text": "boolean"
10994
+ "text": "string"
10766
10995
  },
10767
- "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.",
10768
- "attribute": "nested",
10996
+ "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.",
10997
+ "attribute": "autocorrect",
10769
10998
  "reflects": true,
10770
10999
  "inheritedFrom": {
10771
11000
  "name": "BaseInput",
@@ -10774,14 +11003,13 @@
10774
11003
  },
10775
11004
  {
10776
11005
  "kind": "field",
10777
- "name": "noValidate",
11006
+ "name": "customValidityTypeEmail",
10778
11007
  "privacy": "public",
10779
11008
  "type": {
10780
- "text": "boolean"
11009
+ "text": "string"
10781
11010
  },
10782
- "description": "If set, disables auto-validation on blur.",
10783
- "attribute": "noValidate",
10784
- "reflects": true,
11011
+ "description": "Custom help text message for email type validity.",
11012
+ "attribute": "customValidityTypeEmail",
10785
11013
  "inheritedFrom": {
10786
11014
  "name": "BaseInput",
10787
11015
  "module": "components/input/src/base-input.js"
@@ -10789,28 +11017,28 @@
10789
11017
  },
10790
11018
  {
10791
11019
  "kind": "field",
10792
- "name": "onDark",
11020
+ "name": "disabled",
10793
11021
  "privacy": "public",
10794
11022
  "type": {
10795
11023
  "text": "boolean"
10796
11024
  },
10797
- "attribute": "onDark",
11025
+ "description": "If set, disables the input.",
11026
+ "attribute": "disabled",
10798
11027
  "reflects": true,
10799
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
10800
11028
  "inheritedFrom": {
10801
- "name": "AuroElement",
10802
- "module": "components/layoutElement/src/auroElement.js"
11029
+ "name": "BaseInput",
11030
+ "module": "components/input/src/base-input.js"
10803
11031
  }
10804
11032
  },
10805
11033
  {
10806
11034
  "kind": "field",
10807
- "name": "pattern",
11035
+ "name": "dvInputOnly",
10808
11036
  "privacy": "public",
10809
11037
  "type": {
10810
- "text": "string"
11038
+ "text": "boolean"
10811
11039
  },
10812
- "description": "Specifies a regular expression the form control's value should match.",
10813
- "attribute": "pattern",
11040
+ "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.",
11041
+ "attribute": "dvInputOnly",
10814
11042
  "reflects": true,
10815
11043
  "inheritedFrom": {
10816
11044
  "name": "BaseInput",
@@ -10819,13 +11047,13 @@
10819
11047
  },
10820
11048
  {
10821
11049
  "kind": "field",
10822
- "name": "placeholder",
11050
+ "name": "error",
10823
11051
  "privacy": "public",
10824
11052
  "type": {
10825
11053
  "text": "string"
10826
11054
  },
10827
- "description": "Define custom placeholder text.",
10828
- "attribute": "placeholder",
11055
+ "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.",
11056
+ "attribute": "error",
10829
11057
  "reflects": true,
10830
11058
  "inheritedFrom": {
10831
11059
  "name": "BaseInput",
@@ -10834,14 +11062,13 @@
10834
11062
  },
10835
11063
  {
10836
11064
  "kind": "field",
10837
- "name": "readonly",
11065
+ "name": "errorMessage",
10838
11066
  "privacy": "public",
10839
11067
  "type": {
10840
- "text": "boolean"
11068
+ "text": "string"
10841
11069
  },
10842
- "description": "Makes the input read-only, but can be set programmatically.",
10843
- "attribute": "readonly",
10844
- "reflects": true,
11070
+ "description": "Contains the help text message for the current validity error.",
11071
+ "attribute": "errorMessage",
10845
11072
  "inheritedFrom": {
10846
11073
  "name": "BaseInput",
10847
11074
  "module": "components/input/src/base-input.js"
@@ -10849,13 +11076,13 @@
10849
11076
  },
10850
11077
  {
10851
11078
  "kind": "field",
10852
- "name": "required",
11079
+ "name": "format",
10853
11080
  "privacy": "public",
10854
11081
  "type": {
10855
- "text": "boolean"
11082
+ "text": "string"
10856
11083
  },
10857
- "description": "Populates the `required` attribute on the input. Used for client-side validation.",
10858
- "attribute": "required",
11084
+ "description": "Specifies the input mask format.",
11085
+ "attribute": "format",
10859
11086
  "reflects": true,
10860
11087
  "inheritedFrom": {
10861
11088
  "name": "BaseInput",
@@ -10864,13 +11091,12 @@
10864
11091
  },
10865
11092
  {
10866
11093
  "kind": "field",
10867
- "name": "setCustomValidity",
11094
+ "name": "hasFocus",
10868
11095
  "privacy": "public",
10869
11096
  "type": {
10870
- "text": "string"
11097
+ "text": "boolean"
10871
11098
  },
10872
- "description": "Sets a custom help text message to display for all validityStates.",
10873
- "attribute": "setCustomValidity",
11099
+ "description": "Flag to indicate if the input currently has focus.",
10874
11100
  "inheritedFrom": {
10875
11101
  "name": "BaseInput",
10876
11102
  "module": "components/input/src/base-input.js"
@@ -10878,13 +11104,12 @@
10878
11104
  },
10879
11105
  {
10880
11106
  "kind": "field",
10881
- "name": "setCustomValidityBadInput",
11107
+ "name": "hasValue",
10882
11108
  "privacy": "public",
10883
11109
  "type": {
10884
- "text": "string"
11110
+ "text": "boolean"
10885
11111
  },
10886
- "description": "Custom help text message to display when validity = `badInput`.",
10887
- "attribute": "setCustomValidityBadInput",
11112
+ "description": "Flag to indicate if the input currently has value.",
10888
11113
  "inheritedFrom": {
10889
11114
  "name": "BaseInput",
10890
11115
  "module": "components/input/src/base-input.js"
@@ -10892,13 +11117,14 @@
10892
11117
  },
10893
11118
  {
10894
11119
  "kind": "field",
10895
- "name": "setCustomValidityCustomError",
10896
- "privacy": "public",
11120
+ "name": "hideLabelVisually",
11121
+ "privacy": "private",
10897
11122
  "type": {
10898
- "text": "string"
11123
+ "text": "boolean"
10899
11124
  },
10900
- "description": "Custom help text message to display when validity = `customError`.",
10901
- "attribute": "setCustomValidityCustomError",
11125
+ "description": "If set, the label will be hidden visually but still accessible to assistive technologies.",
11126
+ "attribute": "hideLabelVisually",
11127
+ "reflects": true,
10902
11128
  "inheritedFrom": {
10903
11129
  "name": "BaseInput",
10904
11130
  "module": "components/input/src/base-input.js"
@@ -10906,13 +11132,14 @@
10906
11132
  },
10907
11133
  {
10908
11134
  "kind": "field",
10909
- "name": "setCustomValidityForType",
11135
+ "name": "icon",
10910
11136
  "privacy": "public",
10911
11137
  "type": {
10912
- "text": "string"
11138
+ "text": "boolean"
10913
11139
  },
10914
- "description": "Custom help text message to display for the declared element `type` and type validity fails.",
10915
- "attribute": "setCustomValidityForType",
11140
+ "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.",
11141
+ "attribute": "icon",
11142
+ "reflects": true,
10916
11143
  "inheritedFrom": {
10917
11144
  "name": "BaseInput",
10918
11145
  "module": "components/input/src/base-input.js"
@@ -10920,13 +11147,13 @@
10920
11147
  },
10921
11148
  {
10922
11149
  "kind": "field",
10923
- "name": "setCustomValidityRangeOverflow",
11150
+ "name": "id",
10924
11151
  "privacy": "public",
10925
11152
  "type": {
10926
11153
  "text": "string"
10927
11154
  },
10928
- "description": "Custom help text message to display when validity = `rangeOverflow`.",
10929
- "attribute": "setCustomValidityRangeOverflow",
11155
+ "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
11156
+ "attribute": "id",
10930
11157
  "inheritedFrom": {
10931
11158
  "name": "BaseInput",
10932
11159
  "module": "components/input/src/base-input.js"
@@ -10934,13 +11161,12 @@
10934
11161
  },
10935
11162
  {
10936
11163
  "kind": "field",
10937
- "name": "setCustomValidityRangeUnderflow",
10938
- "privacy": "public",
11164
+ "name": "inputId",
11165
+ "privacy": "private",
10939
11166
  "type": {
10940
11167
  "text": "string"
10941
11168
  },
10942
- "description": "Custom help text message to display when validity = `rangeUnderflow`.",
10943
- "attribute": "setCustomValidityRangeUnderflow",
11169
+ "description": "The id for input node.",
10944
11170
  "inheritedFrom": {
10945
11171
  "name": "BaseInput",
10946
11172
  "module": "components/input/src/base-input.js"
@@ -10948,13 +11174,14 @@
10948
11174
  },
10949
11175
  {
10950
11176
  "kind": "field",
10951
- "name": "setCustomValidityTooLong",
11177
+ "name": "inputmode",
10952
11178
  "privacy": "public",
10953
11179
  "type": {
10954
11180
  "text": "string"
10955
11181
  },
10956
- "description": "Custom help text message to display when validity = `tooLong`.",
10957
- "attribute": "setCustomValidityTooLong",
11182
+ "description": "Exposes inputmode attribute for input.",
11183
+ "attribute": "inputmode",
11184
+ "reflects": true,
10958
11185
  "inheritedFrom": {
10959
11186
  "name": "BaseInput",
10960
11187
  "module": "components/input/src/base-input.js"
@@ -10962,13 +11189,14 @@
10962
11189
  },
10963
11190
  {
10964
11191
  "kind": "field",
10965
- "name": "setCustomValidityTooShort",
11192
+ "name": "lang",
10966
11193
  "privacy": "public",
10967
11194
  "type": {
10968
11195
  "text": "string"
10969
11196
  },
10970
- "description": "Custom help text message to display when validity = `tooShort`.",
10971
- "attribute": "setCustomValidityTooShort",
11197
+ "description": "Defines the language of an element.",
11198
+ "attribute": "lang",
11199
+ "reflects": true,
10972
11200
  "inheritedFrom": {
10973
11201
  "name": "BaseInput",
10974
11202
  "module": "components/input/src/base-input.js"
@@ -10976,13 +11204,13 @@
10976
11204
  },
10977
11205
  {
10978
11206
  "kind": "field",
10979
- "name": "setCustomValidityValueMissing",
11207
+ "name": "max",
10980
11208
  "privacy": "public",
10981
11209
  "type": {
10982
11210
  "text": "string"
10983
11211
  },
10984
- "description": "Custom help text message to display when validity = `valueMissing`.",
10985
- "attribute": "setCustomValidityValueMissing",
11212
+ "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.",
11213
+ "attribute": "max",
10986
11214
  "inheritedFrom": {
10987
11215
  "name": "BaseInput",
10988
11216
  "module": "components/input/src/base-input.js"
@@ -10990,9 +11218,14 @@
10990
11218
  },
10991
11219
  {
10992
11220
  "kind": "field",
10993
- "name": "showPassword",
11221
+ "name": "maxLength",
10994
11222
  "privacy": "public",
10995
- "attribute": "showPassword",
11223
+ "type": {
11224
+ "text": "number"
11225
+ },
11226
+ "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.",
11227
+ "attribute": "maxLength",
11228
+ "reflects": true,
10996
11229
  "inheritedFrom": {
10997
11230
  "name": "BaseInput",
10998
11231
  "module": "components/input/src/base-input.js"
@@ -11000,14 +11233,13 @@
11000
11233
  },
11001
11234
  {
11002
11235
  "kind": "field",
11003
- "name": "simple",
11236
+ "name": "min",
11004
11237
  "privacy": "public",
11005
11238
  "type": {
11006
- "text": "boolean"
11239
+ "text": "string"
11007
11240
  },
11008
- "description": "Simple makes the input render without a border.",
11009
- "attribute": "simple",
11010
- "reflects": true,
11241
+ "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.",
11242
+ "attribute": "min",
11011
11243
  "inheritedFrom": {
11012
11244
  "name": "BaseInput",
11013
11245
  "module": "components/input/src/base-input.js"
@@ -11015,13 +11247,13 @@
11015
11247
  },
11016
11248
  {
11017
11249
  "kind": "field",
11018
- "name": "spellcheck",
11250
+ "name": "minLength",
11019
11251
  "privacy": "public",
11020
11252
  "type": {
11021
- "text": "string"
11253
+ "text": "number"
11022
11254
  },
11023
- "description": "An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.",
11024
- "attribute": "spellcheck",
11255
+ "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.",
11256
+ "attribute": "minLength",
11025
11257
  "reflects": true,
11026
11258
  "inheritedFrom": {
11027
11259
  "name": "BaseInput",
@@ -11030,12 +11262,14 @@
11030
11262
  },
11031
11263
  {
11032
11264
  "kind": "field",
11033
- "name": "touched",
11034
- "privacy": "private",
11265
+ "name": "name",
11266
+ "privacy": "public",
11035
11267
  "type": {
11036
- "text": "boolean"
11268
+ "text": "string"
11037
11269
  },
11038
- "description": "Indicates whether the input is in a dirty state (has been interacted with).",
11270
+ "description": "Populates the `name` attribute on the input.",
11271
+ "attribute": "name",
11272
+ "reflects": true,
11039
11273
  "inheritedFrom": {
11040
11274
  "name": "BaseInput",
11041
11275
  "module": "components/input/src/base-input.js"
@@ -11043,14 +11277,13 @@
11043
11277
  },
11044
11278
  {
11045
11279
  "kind": "field",
11046
- "name": "type",
11280
+ "name": "nested",
11047
11281
  "privacy": "public",
11048
11282
  "type": {
11049
- "text": "'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'"
11283
+ "text": "boolean"
11050
11284
  },
11051
- "description": "Populates the `type` attribute on the input.",
11052
- "default": "'text'",
11053
- "attribute": "type",
11285
+ "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.",
11286
+ "attribute": "nested",
11054
11287
  "reflects": true,
11055
11288
  "inheritedFrom": {
11056
11289
  "name": "BaseInput",
@@ -11059,13 +11292,14 @@
11059
11292
  },
11060
11293
  {
11061
11294
  "kind": "field",
11062
- "name": "validateOnInput",
11295
+ "name": "noValidate",
11063
11296
  "privacy": "public",
11064
11297
  "type": {
11065
11298
  "text": "boolean"
11066
11299
  },
11067
- "description": "Sets validation mode to re-eval with each input.",
11068
- "attribute": "validateOnInput",
11300
+ "description": "If set, disables auto-validation on blur.",
11301
+ "attribute": "noValidate",
11302
+ "reflects": true,
11069
11303
  "inheritedFrom": {
11070
11304
  "name": "BaseInput",
11071
11305
  "module": "components/input/src/base-input.js"
@@ -11073,28 +11307,29 @@
11073
11307
  },
11074
11308
  {
11075
11309
  "kind": "field",
11076
- "name": "validity",
11310
+ "name": "onDark",
11077
11311
  "privacy": "public",
11078
11312
  "type": {
11079
- "text": "string"
11313
+ "text": "boolean"
11080
11314
  },
11081
- "description": "Specifies the `validityState` this element is in.",
11082
- "attribute": "validity",
11315
+ "attribute": "onDark",
11083
11316
  "reflects": true,
11317
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
11084
11318
  "inheritedFrom": {
11085
- "name": "BaseInput",
11086
- "module": "components/input/src/base-input.js"
11319
+ "name": "AuroElement",
11320
+ "module": "components/layoutElement/src/auroElement.js"
11087
11321
  }
11088
11322
  },
11089
11323
  {
11090
11324
  "kind": "field",
11091
- "name": "value",
11325
+ "name": "pattern",
11092
11326
  "privacy": "public",
11093
11327
  "type": {
11094
11328
  "text": "string"
11095
11329
  },
11096
- "description": "Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.",
11097
- "attribute": "value",
11330
+ "description": "Specifies a regular expression the form control's value should match.",
11331
+ "attribute": "pattern",
11332
+ "reflects": true,
11098
11333
  "inheritedFrom": {
11099
11334
  "name": "BaseInput",
11100
11335
  "module": "components/input/src/base-input.js"
@@ -11102,533 +11337,816 @@
11102
11337
  },
11103
11338
  {
11104
11339
  "kind": "field",
11105
- "name": "componentHasFocus",
11106
- "description": "Returns true if the element has focus.",
11107
- "privacy": "private",
11108
- "return": {
11109
- "type": {
11110
- "text": "boolean"
11111
- }
11112
- },
11113
- "readonly": true,
11114
- "inheritedFrom": {
11115
- "name": "AuroElement",
11116
- "module": "components/layoutElement/src/auroElement.js"
11117
- }
11118
- },
11119
- {
11120
- "kind": "method",
11121
- "name": "resetShapeClasses",
11122
- "inheritedFrom": {
11123
- "name": "AuroElement",
11124
- "module": "components/layoutElement/src/auroElement.js"
11125
- }
11126
- },
11127
- {
11128
- "kind": "method",
11129
- "name": "resetLayoutClasses",
11130
- "inheritedFrom": {
11131
- "name": "AuroElement",
11132
- "module": "components/layoutElement/src/auroElement.js"
11133
- }
11134
- },
11135
- {
11136
- "kind": "method",
11137
- "name": "updateComponentArchitecture",
11138
- "inheritedFrom": {
11139
- "name": "AuroElement",
11140
- "module": "components/layoutElement/src/auroElement.js"
11141
- }
11142
- },
11143
- {
11144
- "kind": "field",
11145
- "name": "layout",
11340
+ "name": "placeholder",
11146
11341
  "privacy": "public",
11147
11342
  "type": {
11148
11343
  "text": "string"
11149
11344
  },
11150
- "description": "Defines the language of an element.",
11151
- "default": "{'default'}",
11152
- "attribute": "layout",
11345
+ "description": "Define custom placeholder text.",
11346
+ "attribute": "placeholder",
11153
11347
  "reflects": true,
11154
11348
  "inheritedFrom": {
11155
- "name": "AuroElement",
11156
- "module": "components/layoutElement/src/auroElement.js"
11349
+ "name": "BaseInput",
11350
+ "module": "components/input/src/base-input.js"
11157
11351
  }
11158
11352
  },
11159
11353
  {
11160
11354
  "kind": "field",
11161
- "name": "shape",
11355
+ "name": "readonly",
11162
11356
  "privacy": "public",
11163
11357
  "type": {
11164
- "text": "string"
11358
+ "text": "boolean"
11165
11359
  },
11166
- "attribute": "shape",
11360
+ "description": "Makes the input read-only, but can be set programmatically.",
11361
+ "attribute": "readonly",
11167
11362
  "reflects": true,
11168
11363
  "inheritedFrom": {
11169
- "name": "AuroElement",
11170
- "module": "components/layoutElement/src/auroElement.js"
11364
+ "name": "BaseInput",
11365
+ "module": "components/input/src/base-input.js"
11171
11366
  }
11172
11367
  },
11173
11368
  {
11174
11369
  "kind": "field",
11175
- "name": "size",
11370
+ "name": "required",
11176
11371
  "privacy": "public",
11177
11372
  "type": {
11178
- "text": "string"
11373
+ "text": "boolean"
11179
11374
  },
11180
- "attribute": "size",
11375
+ "description": "Populates the `required` attribute on the input. Used for client-side validation.",
11376
+ "attribute": "required",
11181
11377
  "reflects": true,
11182
11378
  "inheritedFrom": {
11183
- "name": "AuroElement",
11184
- "module": "components/layoutElement/src/auroElement.js"
11379
+ "name": "BaseInput",
11380
+ "module": "components/input/src/base-input.js"
11185
11381
  }
11186
- }
11187
- ],
11188
- "superclass": {
11189
- "name": "BaseInput",
11190
- "module": "/components/input/src/base-input.js"
11191
- },
11192
- "tagName": "auro-input",
11193
- "customElement": true,
11194
- "attributes": [
11382
+ },
11195
11383
  {
11196
- "name": "a11yRole",
11384
+ "kind": "field",
11385
+ "name": "setCustomValidity",
11386
+ "privacy": "public",
11197
11387
  "type": {
11198
11388
  "text": "string"
11199
11389
  },
11200
- "description": "The value for the role attribute.",
11201
- "fieldName": "a11yRole",
11390
+ "description": "Sets a custom help text message to display for all validityStates.",
11391
+ "attribute": "setCustomValidity",
11202
11392
  "inheritedFrom": {
11203
11393
  "name": "BaseInput",
11204
11394
  "module": "components/input/src/base-input.js"
11205
11395
  }
11206
11396
  },
11207
11397
  {
11208
- "name": "a11yControls",
11398
+ "kind": "field",
11399
+ "name": "setCustomValidityBadInput",
11400
+ "privacy": "public",
11209
11401
  "type": {
11210
11402
  "text": "string"
11211
11403
  },
11212
- "description": "The value for the aria-controls attribute.",
11213
- "fieldName": "a11yControls",
11404
+ "description": "Custom help text message to display when validity = `badInput`.",
11405
+ "attribute": "setCustomValidityBadInput",
11214
11406
  "inheritedFrom": {
11215
11407
  "name": "BaseInput",
11216
11408
  "module": "components/input/src/base-input.js"
11217
11409
  }
11218
11410
  },
11219
11411
  {
11220
- "name": "a11yExpanded",
11412
+ "kind": "field",
11413
+ "name": "setCustomValidityCustomError",
11414
+ "privacy": "public",
11221
11415
  "type": {
11222
- "text": "boolean"
11416
+ "text": "string"
11223
11417
  },
11224
- "description": "The value for the aria-expanded attribute.",
11225
- "fieldName": "a11yExpanded",
11418
+ "description": "Custom help text message to display when validity = `customError`.",
11419
+ "attribute": "setCustomValidityCustomError",
11226
11420
  "inheritedFrom": {
11227
11421
  "name": "BaseInput",
11228
11422
  "module": "components/input/src/base-input.js"
11229
11423
  }
11230
11424
  },
11231
11425
  {
11232
- "name": "a11yActivedescendant",
11426
+ "kind": "field",
11427
+ "name": "setCustomValidityForType",
11428
+ "privacy": "public",
11233
11429
  "type": {
11234
11430
  "text": "string"
11235
11431
  },
11236
- "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.",
11237
- "fieldName": "a11yActivedescendant",
11432
+ "description": "Custom help text message to display for the declared element `type` and type validity fails.",
11433
+ "attribute": "setCustomValidityForType",
11238
11434
  "inheritedFrom": {
11239
11435
  "name": "BaseInput",
11240
11436
  "module": "components/input/src/base-input.js"
11241
11437
  }
11242
11438
  },
11243
11439
  {
11244
- "name": "activeLabel",
11440
+ "kind": "field",
11441
+ "name": "setCustomValidityRangeOverflow",
11442
+ "privacy": "public",
11245
11443
  "type": {
11246
- "text": "boolean"
11444
+ "text": "string"
11247
11445
  },
11248
- "description": "If set, the label will remain fixed in the active position.",
11249
- "fieldName": "activeLabel",
11446
+ "description": "Custom help text message to display when validity = `rangeOverflow`.",
11447
+ "attribute": "setCustomValidityRangeOverflow",
11250
11448
  "inheritedFrom": {
11251
11449
  "name": "BaseInput",
11252
11450
  "module": "components/input/src/base-input.js"
11253
11451
  }
11254
11452
  },
11255
11453
  {
11256
- "name": "appearance",
11454
+ "kind": "field",
11455
+ "name": "setCustomValidityRangeUnderflow",
11456
+ "privacy": "public",
11257
11457
  "type": {
11258
- "text": "'default' | 'inverse'"
11458
+ "text": "string"
11259
11459
  },
11260
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
11261
- "default": "'default'",
11262
- "fieldName": "appearance",
11460
+ "description": "Custom help text message to display when validity = `rangeUnderflow`.",
11461
+ "attribute": "setCustomValidityRangeUnderflow",
11263
11462
  "inheritedFrom": {
11264
11463
  "name": "BaseInput",
11265
11464
  "module": "components/input/src/base-input.js"
11266
11465
  }
11267
11466
  },
11268
11467
  {
11269
- "name": "autocapitalize",
11468
+ "kind": "field",
11469
+ "name": "setCustomValidityTooLong",
11470
+ "privacy": "public",
11270
11471
  "type": {
11271
11472
  "text": "string"
11272
11473
  },
11273
- "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].",
11274
- "fieldName": "autocapitalize",
11474
+ "description": "Custom help text message to display when validity = `tooLong`.",
11475
+ "attribute": "setCustomValidityTooLong",
11275
11476
  "inheritedFrom": {
11276
11477
  "name": "BaseInput",
11277
11478
  "module": "components/input/src/base-input.js"
11278
11479
  }
11279
11480
  },
11280
11481
  {
11281
- "name": "autocomplete",
11482
+ "kind": "field",
11483
+ "name": "setCustomValidityTooShort",
11484
+ "privacy": "public",
11282
11485
  "type": {
11283
11486
  "text": "string"
11284
11487
  },
11285
- "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
11286
- "fieldName": "autocomplete",
11488
+ "description": "Custom help text message to display when validity = `tooShort`.",
11489
+ "attribute": "setCustomValidityTooShort",
11287
11490
  "inheritedFrom": {
11288
11491
  "name": "BaseInput",
11289
11492
  "module": "components/input/src/base-input.js"
11290
11493
  }
11291
11494
  },
11292
11495
  {
11293
- "name": "autocorrect",
11496
+ "kind": "field",
11497
+ "name": "setCustomValidityValueMissing",
11498
+ "privacy": "public",
11294
11499
  "type": {
11295
11500
  "text": "string"
11296
11501
  },
11297
- "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.",
11298
- "fieldName": "autocorrect",
11502
+ "description": "Custom help text message to display when validity = `valueMissing`.",
11503
+ "attribute": "setCustomValidityValueMissing",
11299
11504
  "inheritedFrom": {
11300
11505
  "name": "BaseInput",
11301
11506
  "module": "components/input/src/base-input.js"
11302
11507
  }
11303
11508
  },
11304
11509
  {
11305
- "name": "customValidityTypeEmail",
11306
- "type": {
11307
- "text": "string"
11308
- },
11309
- "description": "Custom help text message for email type validity.",
11310
- "fieldName": "customValidityTypeEmail",
11510
+ "kind": "field",
11511
+ "name": "showPassword",
11512
+ "privacy": "public",
11513
+ "attribute": "showPassword",
11311
11514
  "inheritedFrom": {
11312
11515
  "name": "BaseInput",
11313
11516
  "module": "components/input/src/base-input.js"
11314
11517
  }
11315
11518
  },
11316
11519
  {
11317
- "name": "disabled",
11520
+ "kind": "field",
11521
+ "name": "simple",
11522
+ "privacy": "public",
11318
11523
  "type": {
11319
11524
  "text": "boolean"
11320
11525
  },
11321
- "description": "If set, disables the input.",
11322
- "fieldName": "disabled",
11526
+ "description": "Simple makes the input render without a border.",
11527
+ "attribute": "simple",
11528
+ "reflects": true,
11323
11529
  "inheritedFrom": {
11324
11530
  "name": "BaseInput",
11325
11531
  "module": "components/input/src/base-input.js"
11326
11532
  }
11327
11533
  },
11328
11534
  {
11329
- "name": "dvInputOnly",
11535
+ "kind": "field",
11536
+ "name": "spellcheck",
11537
+ "privacy": "public",
11330
11538
  "type": {
11331
- "text": "boolean"
11539
+ "text": "string"
11332
11540
  },
11333
- "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.",
11334
- "fieldName": "dvInputOnly",
11541
+ "description": "An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.",
11542
+ "attribute": "spellcheck",
11543
+ "reflects": true,
11335
11544
  "inheritedFrom": {
11336
11545
  "name": "BaseInput",
11337
11546
  "module": "components/input/src/base-input.js"
11338
11547
  }
11339
11548
  },
11340
11549
  {
11341
- "name": "error",
11550
+ "kind": "field",
11551
+ "name": "touched",
11552
+ "privacy": "private",
11342
11553
  "type": {
11343
- "text": "string"
11554
+ "text": "boolean"
11344
11555
  },
11345
- "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.",
11346
- "fieldName": "error",
11556
+ "description": "Indicates whether the input is in a dirty state (has been interacted with).",
11347
11557
  "inheritedFrom": {
11348
11558
  "name": "BaseInput",
11349
11559
  "module": "components/input/src/base-input.js"
11350
11560
  }
11351
11561
  },
11352
11562
  {
11353
- "name": "errorMessage",
11563
+ "kind": "field",
11564
+ "name": "type",
11565
+ "privacy": "public",
11354
11566
  "type": {
11355
- "text": "string"
11567
+ "text": "'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'"
11356
11568
  },
11357
- "description": "Contains the help text message for the current validity error.",
11358
- "fieldName": "errorMessage",
11569
+ "description": "Populates the `type` attribute on the input.",
11570
+ "default": "'text'",
11571
+ "attribute": "type",
11572
+ "reflects": true,
11359
11573
  "inheritedFrom": {
11360
11574
  "name": "BaseInput",
11361
11575
  "module": "components/input/src/base-input.js"
11362
11576
  }
11363
11577
  },
11364
11578
  {
11365
- "name": "format",
11579
+ "kind": "field",
11580
+ "name": "validateOnInput",
11581
+ "privacy": "public",
11366
11582
  "type": {
11367
- "text": "string"
11583
+ "text": "boolean"
11368
11584
  },
11369
- "description": "Specifies the input mask format.",
11370
- "fieldName": "format",
11585
+ "description": "Sets validation mode to re-eval with each input.",
11586
+ "attribute": "validateOnInput",
11371
11587
  "inheritedFrom": {
11372
11588
  "name": "BaseInput",
11373
11589
  "module": "components/input/src/base-input.js"
11374
11590
  }
11375
11591
  },
11376
11592
  {
11377
- "name": "hideLabelVisually",
11593
+ "kind": "field",
11594
+ "name": "validity",
11595
+ "privacy": "public",
11378
11596
  "type": {
11379
- "text": "boolean"
11597
+ "text": "string"
11380
11598
  },
11381
- "description": "If set, the label will be hidden visually but still accessible to assistive technologies.",
11382
- "fieldName": "hideLabelVisually",
11599
+ "description": "Specifies the `validityState` this element is in.",
11600
+ "attribute": "validity",
11601
+ "reflects": true,
11383
11602
  "inheritedFrom": {
11384
11603
  "name": "BaseInput",
11385
11604
  "module": "components/input/src/base-input.js"
11386
11605
  }
11387
11606
  },
11388
11607
  {
11389
- "name": "icon",
11608
+ "kind": "field",
11609
+ "name": "value",
11610
+ "privacy": "public",
11390
11611
  "type": {
11391
- "text": "boolean"
11612
+ "text": "string"
11392
11613
  },
11393
- "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.",
11394
- "fieldName": "icon",
11614
+ "description": "Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.",
11615
+ "attribute": "value",
11395
11616
  "inheritedFrom": {
11396
11617
  "name": "BaseInput",
11397
11618
  "module": "components/input/src/base-input.js"
11398
11619
  }
11399
11620
  },
11400
11621
  {
11401
- "name": "id",
11402
- "type": {
11403
- "text": "string"
11622
+ "kind": "field",
11623
+ "name": "componentHasFocus",
11624
+ "description": "Returns true if the element has focus.",
11625
+ "privacy": "private",
11626
+ "return": {
11627
+ "type": {
11628
+ "text": "boolean"
11629
+ }
11404
11630
  },
11405
- "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
11406
- "fieldName": "id",
11631
+ "readonly": true,
11407
11632
  "inheritedFrom": {
11408
- "name": "BaseInput",
11409
- "module": "components/input/src/base-input.js"
11633
+ "name": "AuroElement",
11634
+ "module": "components/layoutElement/src/auroElement.js"
11410
11635
  }
11411
11636
  },
11412
11637
  {
11413
- "name": "inputmode",
11638
+ "kind": "method",
11639
+ "name": "resetShapeClasses",
11640
+ "inheritedFrom": {
11641
+ "name": "AuroElement",
11642
+ "module": "components/layoutElement/src/auroElement.js"
11643
+ }
11644
+ },
11645
+ {
11646
+ "kind": "method",
11647
+ "name": "resetLayoutClasses",
11648
+ "inheritedFrom": {
11649
+ "name": "AuroElement",
11650
+ "module": "components/layoutElement/src/auroElement.js"
11651
+ }
11652
+ },
11653
+ {
11654
+ "kind": "method",
11655
+ "name": "updateComponentArchitecture",
11656
+ "inheritedFrom": {
11657
+ "name": "AuroElement",
11658
+ "module": "components/layoutElement/src/auroElement.js"
11659
+ }
11660
+ },
11661
+ {
11662
+ "kind": "field",
11663
+ "name": "layout",
11664
+ "privacy": "public",
11414
11665
  "type": {
11415
11666
  "text": "string"
11416
11667
  },
11417
- "description": "Exposes inputmode attribute for input.",
11418
- "fieldName": "inputmode",
11668
+ "description": "Defines the language of an element.",
11669
+ "default": "{'default'}",
11670
+ "attribute": "layout",
11671
+ "reflects": true,
11419
11672
  "inheritedFrom": {
11420
- "name": "BaseInput",
11421
- "module": "components/input/src/base-input.js"
11673
+ "name": "AuroElement",
11674
+ "module": "components/layoutElement/src/auroElement.js"
11422
11675
  }
11423
11676
  },
11424
11677
  {
11425
- "name": "lang",
11678
+ "kind": "field",
11679
+ "name": "shape",
11680
+ "privacy": "public",
11426
11681
  "type": {
11427
11682
  "text": "string"
11428
11683
  },
11429
- "description": "Defines the language of an element.",
11430
- "fieldName": "lang",
11684
+ "attribute": "shape",
11685
+ "reflects": true,
11431
11686
  "inheritedFrom": {
11432
- "name": "BaseInput",
11433
- "module": "components/input/src/base-input.js"
11687
+ "name": "AuroElement",
11688
+ "module": "components/layoutElement/src/auroElement.js"
11434
11689
  }
11435
11690
  },
11436
11691
  {
11437
- "name": "max",
11692
+ "kind": "field",
11693
+ "name": "size",
11694
+ "privacy": "public",
11438
11695
  "type": {
11439
11696
  "text": "string"
11440
11697
  },
11441
- "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.",
11442
- "fieldName": "max",
11698
+ "attribute": "size",
11699
+ "reflects": true,
11443
11700
  "inheritedFrom": {
11444
- "name": "BaseInput",
11445
- "module": "components/input/src/base-input.js"
11701
+ "name": "AuroElement",
11702
+ "module": "components/layoutElement/src/auroElement.js"
11446
11703
  }
11447
- },
11704
+ }
11705
+ ],
11706
+ "superclass": {
11707
+ "name": "BaseInput",
11708
+ "module": "/components/input/src/base-input.js"
11709
+ },
11710
+ "tagName": "auro-input",
11711
+ "customElement": true,
11712
+ "attributes": [
11448
11713
  {
11449
- "name": "maxLength",
11714
+ "name": "a11yRole",
11450
11715
  "type": {
11451
- "text": "number"
11716
+ "text": "string"
11452
11717
  },
11453
- "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.",
11454
- "fieldName": "maxLength",
11718
+ "description": "The value for the role attribute.",
11719
+ "fieldName": "a11yRole",
11455
11720
  "inheritedFrom": {
11456
11721
  "name": "BaseInput",
11457
11722
  "module": "components/input/src/base-input.js"
11458
11723
  }
11459
11724
  },
11460
11725
  {
11461
- "name": "min",
11726
+ "name": "a11yControls",
11462
11727
  "type": {
11463
11728
  "text": "string"
11464
11729
  },
11465
- "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.",
11466
- "fieldName": "min",
11730
+ "description": "The value for the aria-controls attribute.",
11731
+ "fieldName": "a11yControls",
11467
11732
  "inheritedFrom": {
11468
11733
  "name": "BaseInput",
11469
11734
  "module": "components/input/src/base-input.js"
11470
11735
  }
11471
11736
  },
11472
11737
  {
11473
- "name": "minLength",
11738
+ "name": "a11yExpanded",
11474
11739
  "type": {
11475
- "text": "number"
11740
+ "text": "boolean"
11476
11741
  },
11477
- "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.",
11478
- "fieldName": "minLength",
11742
+ "description": "The value for the aria-expanded attribute.",
11743
+ "fieldName": "a11yExpanded",
11479
11744
  "inheritedFrom": {
11480
11745
  "name": "BaseInput",
11481
11746
  "module": "components/input/src/base-input.js"
11482
11747
  }
11483
11748
  },
11484
11749
  {
11485
- "name": "name",
11750
+ "name": "a11yActivedescendant",
11486
11751
  "type": {
11487
11752
  "text": "string"
11488
11753
  },
11489
- "description": "Populates the `name` attribute on the input.",
11490
- "fieldName": "name",
11754
+ "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.",
11755
+ "fieldName": "a11yActivedescendant",
11491
11756
  "inheritedFrom": {
11492
11757
  "name": "BaseInput",
11493
11758
  "module": "components/input/src/base-input.js"
11494
11759
  }
11495
11760
  },
11496
11761
  {
11497
- "name": "nested",
11762
+ "name": "activeLabel",
11498
11763
  "type": {
11499
11764
  "text": "boolean"
11500
11765
  },
11501
- "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.",
11502
- "fieldName": "nested",
11766
+ "description": "If set, the label will remain fixed in the active position.",
11767
+ "fieldName": "activeLabel",
11503
11768
  "inheritedFrom": {
11504
11769
  "name": "BaseInput",
11505
11770
  "module": "components/input/src/base-input.js"
11506
11771
  }
11507
11772
  },
11508
11773
  {
11509
- "name": "noValidate",
11774
+ "name": "appearance",
11510
11775
  "type": {
11511
- "text": "boolean"
11776
+ "text": "'default' | 'inverse'"
11512
11777
  },
11513
- "description": "If set, disables auto-validation on blur.",
11514
- "fieldName": "noValidate",
11778
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
11779
+ "default": "'default'",
11780
+ "fieldName": "appearance",
11515
11781
  "inheritedFrom": {
11516
11782
  "name": "BaseInput",
11517
11783
  "module": "components/input/src/base-input.js"
11518
11784
  }
11519
11785
  },
11520
11786
  {
11521
- "name": "onDark",
11787
+ "name": "autocapitalize",
11522
11788
  "type": {
11523
- "text": "boolean"
11789
+ "text": "string"
11524
11790
  },
11525
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
11526
- "fieldName": "onDark",
11791
+ "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].",
11792
+ "fieldName": "autocapitalize",
11527
11793
  "inheritedFrom": {
11528
11794
  "name": "BaseInput",
11529
11795
  "module": "components/input/src/base-input.js"
11530
11796
  }
11531
11797
  },
11532
11798
  {
11533
- "name": "pattern",
11799
+ "name": "autocomplete",
11534
11800
  "type": {
11535
11801
  "text": "string"
11536
11802
  },
11537
- "description": "Specifies a regular expression the form control's value should match.",
11538
- "fieldName": "pattern",
11803
+ "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
11804
+ "fieldName": "autocomplete",
11539
11805
  "inheritedFrom": {
11540
11806
  "name": "BaseInput",
11541
11807
  "module": "components/input/src/base-input.js"
11542
11808
  }
11543
11809
  },
11544
11810
  {
11545
- "name": "placeholder",
11811
+ "name": "autocorrect",
11546
11812
  "type": {
11547
11813
  "text": "string"
11548
11814
  },
11549
- "description": "Define custom placeholder text.",
11550
- "fieldName": "placeholder",
11815
+ "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.",
11816
+ "fieldName": "autocorrect",
11551
11817
  "inheritedFrom": {
11552
11818
  "name": "BaseInput",
11553
11819
  "module": "components/input/src/base-input.js"
11554
11820
  }
11555
11821
  },
11556
11822
  {
11557
- "name": "readonly",
11823
+ "name": "customValidityTypeEmail",
11558
11824
  "type": {
11559
- "text": "boolean"
11825
+ "text": "string"
11560
11826
  },
11561
- "description": "Makes the input read-only, but can be set programmatically.",
11562
- "fieldName": "readonly",
11827
+ "description": "Custom help text message for email type validity.",
11828
+ "fieldName": "customValidityTypeEmail",
11563
11829
  "inheritedFrom": {
11564
11830
  "name": "BaseInput",
11565
11831
  "module": "components/input/src/base-input.js"
11566
11832
  }
11567
11833
  },
11568
11834
  {
11569
- "name": "required",
11835
+ "name": "disabled",
11570
11836
  "type": {
11571
11837
  "text": "boolean"
11572
11838
  },
11573
- "description": "Populates the `required` attribute on the input. Used for client-side validation.",
11574
- "fieldName": "required",
11839
+ "description": "If set, disables the input.",
11840
+ "fieldName": "disabled",
11575
11841
  "inheritedFrom": {
11576
11842
  "name": "BaseInput",
11577
11843
  "module": "components/input/src/base-input.js"
11578
11844
  }
11579
11845
  },
11580
11846
  {
11581
- "name": "setCustomValidity",
11847
+ "name": "dvInputOnly",
11582
11848
  "type": {
11583
- "text": "string"
11849
+ "text": "boolean"
11584
11850
  },
11585
- "description": "Sets a custom help text message to display for all validityStates.",
11586
- "fieldName": "setCustomValidity",
11851
+ "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.",
11852
+ "fieldName": "dvInputOnly",
11587
11853
  "inheritedFrom": {
11588
11854
  "name": "BaseInput",
11589
11855
  "module": "components/input/src/base-input.js"
11590
11856
  }
11591
11857
  },
11592
11858
  {
11593
- "name": "setCustomValidityBadInput",
11859
+ "name": "error",
11594
11860
  "type": {
11595
11861
  "text": "string"
11596
11862
  },
11597
- "description": "Custom help text message to display when validity = `badInput`.",
11598
- "fieldName": "setCustomValidityBadInput",
11863
+ "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.",
11864
+ "fieldName": "error",
11599
11865
  "inheritedFrom": {
11600
11866
  "name": "BaseInput",
11601
11867
  "module": "components/input/src/base-input.js"
11602
11868
  }
11603
11869
  },
11604
11870
  {
11605
- "name": "setCustomValidityCustomError",
11871
+ "name": "errorMessage",
11606
11872
  "type": {
11607
11873
  "text": "string"
11608
11874
  },
11609
- "description": "Custom help text message to display when validity = `customError`.",
11610
- "fieldName": "setCustomValidityCustomError",
11875
+ "description": "Contains the help text message for the current validity error.",
11876
+ "fieldName": "errorMessage",
11611
11877
  "inheritedFrom": {
11612
11878
  "name": "BaseInput",
11613
11879
  "module": "components/input/src/base-input.js"
11614
11880
  }
11615
11881
  },
11616
11882
  {
11617
- "name": "setCustomValidityForType",
11883
+ "name": "format",
11618
11884
  "type": {
11619
11885
  "text": "string"
11620
11886
  },
11621
- "description": "Custom help text message to display for the declared element `type` and type validity fails.",
11622
- "fieldName": "setCustomValidityForType",
11887
+ "description": "Specifies the input mask format.",
11888
+ "fieldName": "format",
11623
11889
  "inheritedFrom": {
11624
11890
  "name": "BaseInput",
11625
11891
  "module": "components/input/src/base-input.js"
11626
11892
  }
11627
11893
  },
11628
11894
  {
11629
- "name": "setCustomValidityRangeOverflow",
11895
+ "name": "hideLabelVisually",
11630
11896
  "type": {
11631
- "text": "string"
11897
+ "text": "boolean"
11898
+ },
11899
+ "description": "If set, the label will be hidden visually but still accessible to assistive technologies.",
11900
+ "fieldName": "hideLabelVisually",
11901
+ "inheritedFrom": {
11902
+ "name": "BaseInput",
11903
+ "module": "components/input/src/base-input.js"
11904
+ }
11905
+ },
11906
+ {
11907
+ "name": "icon",
11908
+ "type": {
11909
+ "text": "boolean"
11910
+ },
11911
+ "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.",
11912
+ "fieldName": "icon",
11913
+ "inheritedFrom": {
11914
+ "name": "BaseInput",
11915
+ "module": "components/input/src/base-input.js"
11916
+ }
11917
+ },
11918
+ {
11919
+ "name": "id",
11920
+ "type": {
11921
+ "text": "string"
11922
+ },
11923
+ "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
11924
+ "fieldName": "id",
11925
+ "inheritedFrom": {
11926
+ "name": "BaseInput",
11927
+ "module": "components/input/src/base-input.js"
11928
+ }
11929
+ },
11930
+ {
11931
+ "name": "inputmode",
11932
+ "type": {
11933
+ "text": "string"
11934
+ },
11935
+ "description": "Exposes inputmode attribute for input.",
11936
+ "fieldName": "inputmode",
11937
+ "inheritedFrom": {
11938
+ "name": "BaseInput",
11939
+ "module": "components/input/src/base-input.js"
11940
+ }
11941
+ },
11942
+ {
11943
+ "name": "lang",
11944
+ "type": {
11945
+ "text": "string"
11946
+ },
11947
+ "description": "Defines the language of an element.",
11948
+ "fieldName": "lang",
11949
+ "inheritedFrom": {
11950
+ "name": "BaseInput",
11951
+ "module": "components/input/src/base-input.js"
11952
+ }
11953
+ },
11954
+ {
11955
+ "name": "max",
11956
+ "type": {
11957
+ "text": "string"
11958
+ },
11959
+ "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.",
11960
+ "fieldName": "max",
11961
+ "inheritedFrom": {
11962
+ "name": "BaseInput",
11963
+ "module": "components/input/src/base-input.js"
11964
+ }
11965
+ },
11966
+ {
11967
+ "name": "maxLength",
11968
+ "type": {
11969
+ "text": "number"
11970
+ },
11971
+ "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.",
11972
+ "fieldName": "maxLength",
11973
+ "inheritedFrom": {
11974
+ "name": "BaseInput",
11975
+ "module": "components/input/src/base-input.js"
11976
+ }
11977
+ },
11978
+ {
11979
+ "name": "min",
11980
+ "type": {
11981
+ "text": "string"
11982
+ },
11983
+ "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.",
11984
+ "fieldName": "min",
11985
+ "inheritedFrom": {
11986
+ "name": "BaseInput",
11987
+ "module": "components/input/src/base-input.js"
11988
+ }
11989
+ },
11990
+ {
11991
+ "name": "minLength",
11992
+ "type": {
11993
+ "text": "number"
11994
+ },
11995
+ "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.",
11996
+ "fieldName": "minLength",
11997
+ "inheritedFrom": {
11998
+ "name": "BaseInput",
11999
+ "module": "components/input/src/base-input.js"
12000
+ }
12001
+ },
12002
+ {
12003
+ "name": "name",
12004
+ "type": {
12005
+ "text": "string"
12006
+ },
12007
+ "description": "Populates the `name` attribute on the input.",
12008
+ "fieldName": "name",
12009
+ "inheritedFrom": {
12010
+ "name": "BaseInput",
12011
+ "module": "components/input/src/base-input.js"
12012
+ }
12013
+ },
12014
+ {
12015
+ "name": "nested",
12016
+ "type": {
12017
+ "text": "boolean"
12018
+ },
12019
+ "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.",
12020
+ "fieldName": "nested",
12021
+ "inheritedFrom": {
12022
+ "name": "BaseInput",
12023
+ "module": "components/input/src/base-input.js"
12024
+ }
12025
+ },
12026
+ {
12027
+ "name": "noValidate",
12028
+ "type": {
12029
+ "text": "boolean"
12030
+ },
12031
+ "description": "If set, disables auto-validation on blur.",
12032
+ "fieldName": "noValidate",
12033
+ "inheritedFrom": {
12034
+ "name": "BaseInput",
12035
+ "module": "components/input/src/base-input.js"
12036
+ }
12037
+ },
12038
+ {
12039
+ "name": "onDark",
12040
+ "type": {
12041
+ "text": "boolean"
12042
+ },
12043
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
12044
+ "fieldName": "onDark",
12045
+ "inheritedFrom": {
12046
+ "name": "BaseInput",
12047
+ "module": "components/input/src/base-input.js"
12048
+ }
12049
+ },
12050
+ {
12051
+ "name": "pattern",
12052
+ "type": {
12053
+ "text": "string"
12054
+ },
12055
+ "description": "Specifies a regular expression the form control's value should match.",
12056
+ "fieldName": "pattern",
12057
+ "inheritedFrom": {
12058
+ "name": "BaseInput",
12059
+ "module": "components/input/src/base-input.js"
12060
+ }
12061
+ },
12062
+ {
12063
+ "name": "placeholder",
12064
+ "type": {
12065
+ "text": "string"
12066
+ },
12067
+ "description": "Define custom placeholder text.",
12068
+ "fieldName": "placeholder",
12069
+ "inheritedFrom": {
12070
+ "name": "BaseInput",
12071
+ "module": "components/input/src/base-input.js"
12072
+ }
12073
+ },
12074
+ {
12075
+ "name": "readonly",
12076
+ "type": {
12077
+ "text": "boolean"
12078
+ },
12079
+ "description": "Makes the input read-only, but can be set programmatically.",
12080
+ "fieldName": "readonly",
12081
+ "inheritedFrom": {
12082
+ "name": "BaseInput",
12083
+ "module": "components/input/src/base-input.js"
12084
+ }
12085
+ },
12086
+ {
12087
+ "name": "required",
12088
+ "type": {
12089
+ "text": "boolean"
12090
+ },
12091
+ "description": "Populates the `required` attribute on the input. Used for client-side validation.",
12092
+ "fieldName": "required",
12093
+ "inheritedFrom": {
12094
+ "name": "BaseInput",
12095
+ "module": "components/input/src/base-input.js"
12096
+ }
12097
+ },
12098
+ {
12099
+ "name": "setCustomValidity",
12100
+ "type": {
12101
+ "text": "string"
12102
+ },
12103
+ "description": "Sets a custom help text message to display for all validityStates.",
12104
+ "fieldName": "setCustomValidity",
12105
+ "inheritedFrom": {
12106
+ "name": "BaseInput",
12107
+ "module": "components/input/src/base-input.js"
12108
+ }
12109
+ },
12110
+ {
12111
+ "name": "setCustomValidityBadInput",
12112
+ "type": {
12113
+ "text": "string"
12114
+ },
12115
+ "description": "Custom help text message to display when validity = `badInput`.",
12116
+ "fieldName": "setCustomValidityBadInput",
12117
+ "inheritedFrom": {
12118
+ "name": "BaseInput",
12119
+ "module": "components/input/src/base-input.js"
12120
+ }
12121
+ },
12122
+ {
12123
+ "name": "setCustomValidityCustomError",
12124
+ "type": {
12125
+ "text": "string"
12126
+ },
12127
+ "description": "Custom help text message to display when validity = `customError`.",
12128
+ "fieldName": "setCustomValidityCustomError",
12129
+ "inheritedFrom": {
12130
+ "name": "BaseInput",
12131
+ "module": "components/input/src/base-input.js"
12132
+ }
12133
+ },
12134
+ {
12135
+ "name": "setCustomValidityForType",
12136
+ "type": {
12137
+ "text": "string"
12138
+ },
12139
+ "description": "Custom help text message to display for the declared element `type` and type validity fails.",
12140
+ "fieldName": "setCustomValidityForType",
12141
+ "inheritedFrom": {
12142
+ "name": "BaseInput",
12143
+ "module": "components/input/src/base-input.js"
12144
+ }
12145
+ },
12146
+ {
12147
+ "name": "setCustomValidityRangeOverflow",
12148
+ "type": {
12149
+ "text": "string"
11632
12150
  },
11633
12151
  "description": "Custom help text message to display when validity = `rangeOverflow`.",
11634
12152
  "fieldName": "setCustomValidityRangeOverflow",
@@ -13429,649 +13947,131 @@
13429
13947
  "module": "components/input/src/iconVersion.js"
13430
13948
  }
13431
13949
  }
13432
- ]
13433
- },
13434
- {
13435
- "kind": "javascript-module",
13436
- "path": "components/input/src/index.js",
13437
- "declarations": [],
13438
- "exports": [
13439
- {
13440
- "kind": "js",
13441
- "name": "AuroInput",
13442
- "declaration": {
13443
- "name": "AuroInput",
13444
- "module": "components/input/src/index.js"
13445
- }
13446
- }
13447
- ]
13448
- },
13449
- {
13450
- "kind": "javascript-module",
13451
- "path": "components/input/src/registered.js",
13452
- "declarations": [],
13453
- "exports": []
13454
- },
13455
- {
13456
- "kind": "javascript-module",
13457
- "path": "components/input/src/utilities.js",
13458
- "declarations": [
13459
- {
13460
- "kind": "class",
13461
- "description": "",
13462
- "name": "AuroInputUtilities",
13463
- "members": [
13464
- {
13465
- "kind": "method",
13466
- "name": "getMaskOptions",
13467
- "parameters": [
13468
- {
13469
- "name": "type",
13470
- "description": "The input type.",
13471
- "type": {
13472
- "text": "string"
13473
- }
13474
- },
13475
- {
13476
- "name": "format",
13477
- "description": "The format of the mask to apply.",
13478
- "type": {
13479
- "text": "string"
13480
- }
13481
- }
13482
- ],
13483
- "description": "Configures the mask to be used on the input element based on format and/or type.\nIMask tool documentation: https://imask.js.org/.",
13484
- "privacy": "private",
13485
- "return": {
13486
- "type": {
13487
- "text": "void"
13488
- }
13489
- }
13490
- },
13491
- {
13492
- "kind": "method",
13493
- "name": "toNorthAmericanFormat",
13494
- "parameters": [
13495
- {
13496
- "name": "dateStr",
13497
- "description": "Date string to format.",
13498
- "type": {
13499
- "text": "string"
13500
- }
13501
- },
13502
- {
13503
- "name": "format",
13504
- "description": "Date format to use.",
13505
- "type": {
13506
- "text": "string"
13507
- }
13508
- }
13509
- ],
13510
- "privacy": "private",
13511
- "return": {
13512
- "type": {
13513
- "text": "void"
13514
- }
13515
- }
13516
- },
13517
- {
13518
- "kind": "method",
13519
- "name": "parseDate",
13520
- "parameters": [
13521
- {
13522
- "name": "dateStr",
13523
- "description": "Date string to parse.",
13524
- "type": {
13525
- "text": "string"
13526
- }
13527
- },
13528
- {
13529
- "name": "format",
13530
- "description": "Date format to parse.",
13531
- "type": {
13532
- "text": "string"
13533
- }
13534
- }
13535
- ],
13536
- "privacy": "private",
13537
- "return": {
13538
- "type": {
13539
- "text": "void"
13540
- }
13541
- }
13542
- }
13543
- ]
13544
- }
13545
- ],
13546
- "exports": [
13547
- {
13548
- "kind": "js",
13549
- "name": "AuroInputUtilities",
13550
- "declaration": {
13551
- "name": "AuroInputUtilities",
13552
- "module": "components/input/src/utilities.js"
13553
- }
13554
- }
13555
- ]
13556
- },
13557
- {
13558
- "kind": "javascript-module",
13559
- "path": "components/form/src/auro-form.js",
13560
- "declarations": [
13561
- {
13562
- "kind": "class",
13563
- "description": "The `auro-form` element provides users a way to create and manage forms in a consistent manner.",
13564
- "name": "AuroForm",
13565
- "slots": [
13566
- {
13567
- "description": "The default slot for form elements.",
13568
- "name": "default"
13569
- }
13570
- ],
13571
- "members": [
13572
- {
13573
- "kind": "field",
13574
- "name": "formElementTags",
13575
- "static": true,
13576
- "readonly": true
13577
- },
13578
- {
13579
- "kind": "method",
13580
- "name": "_isElementTag",
13581
- "parameters": [
13582
- {
13583
- "name": "elementTag",
13584
- "description": "The HTML tag name like `auro-datepicker`.",
13585
- "type": {
13586
- "text": "string"
13587
- }
13588
- },
13589
- {
13590
- "name": "element",
13591
- "description": "The actual HTML element to compare.",
13592
- "type": {
13593
- "text": "HTMLElement"
13594
- }
13595
- }
13596
- ],
13597
- "description": "Compare tag name with element to identify it (for API purposes).",
13598
- "return": {
13599
- "type": {
13600
- "text": "boolean"
13601
- }
13602
- },
13603
- "privacy": "private"
13604
- },
13605
- {
13606
- "kind": "method",
13607
- "name": "_isInElementCollection",
13608
- "parameters": [
13609
- {
13610
- "name": "collection",
13611
- "description": "The array to use for tag name search.",
13612
- "type": {
13613
- "text": "string[]"
13614
- }
13615
- },
13616
- {
13617
- "name": "element",
13618
- "description": "The element to compare against the master list.",
13619
- "type": {
13620
- "text": "HTMLElement"
13621
- }
13622
- }
13623
- ],
13624
- "description": "Shared code for determining if an element is something we care about (submit, form element, etc.).",
13625
- "return": {
13626
- "type": {
13627
- "text": "boolean"
13628
- }
13629
- },
13630
- "privacy": "private"
13631
- },
13632
- {
13633
- "kind": "method",
13634
- "name": "isFormElement",
13635
- "parameters": [
13636
- {
13637
- "name": "element",
13638
- "description": "The element to check (attr or tag name).",
13639
- "type": {
13640
- "text": "HTMLElement"
13641
- }
13642
- }
13643
- ],
13644
- "description": "Check if the tag name is a form element.",
13645
- "return": {
13646
- "type": {
13647
- "text": "boolean"
13648
- }
13649
- },
13650
- "privacy": "private"
13651
- },
13652
- {
13653
- "kind": "method",
13654
- "name": "_eventIsValidFormEvent",
13655
- "parameters": [
13656
- {
13657
- "name": "event",
13658
- "description": "The event to validate.",
13659
- "type": {
13660
- "text": "Event"
13661
- }
13662
- }
13663
- ],
13664
- "description": "Validates if an event is from a valid form element with a name.",
13665
- "return": {
13666
- "type": {
13667
- "text": "boolean"
13668
- }
13669
- },
13670
- "privacy": "private"
13671
- },
13672
- {
13673
- "kind": "field",
13674
- "name": "buttonElementTags",
13675
- "static": true,
13676
- "readonly": true
13677
- },
13678
- {
13679
- "kind": "method",
13680
- "name": "isButtonElement",
13681
- "parameters": [
13682
- {
13683
- "name": "element",
13684
- "description": "The element to check.",
13685
- "type": {
13686
- "text": "HTMLElement"
13687
- }
13688
- }
13689
- ],
13690
- "description": "Check if the tag name is a button element.",
13691
- "return": {
13692
- "type": {
13693
- "text": "boolean"
13694
- }
13695
- },
13696
- "privacy": "private"
13697
- },
13698
- {
13699
- "kind": "field",
13700
- "name": "value",
13701
- "description": "Returns the current values of all named form elements as a key-value object, keyed by each element's `name` attribute.",
13702
- "return": {
13703
- "type": {
13704
- "text": "Record<string, string | number | boolean | string[] | null>"
13705
- }
13706
- },
13707
- "readonly": true
13708
- },
13709
- {
13710
- "kind": "field",
13711
- "name": "submitElements",
13712
- "description": "Getter for internal _submitElements.",
13713
- "return": {
13714
- "type": {
13715
- "text": "HTMLButtonElement[]"
13716
- }
13717
- },
13718
- "privacy": "private",
13719
- "readonly": true
13720
- },
13721
- {
13722
- "kind": "field",
13723
- "name": "resetElements",
13724
- "description": "Returns a collection of elements that will reset the form.",
13725
- "return": {
13726
- "type": {
13727
- "text": "HTMLButtonElement[]"
13728
- }
13729
- },
13730
- "privacy": "private",
13731
- "readonly": true
13732
- },
13733
- {
13734
- "kind": "method",
13735
- "name": "_calculateValidity",
13736
- "description": "Infer validity status based on current formState.",
13737
- "privacy": "private"
13738
- },
13739
- {
13740
- "kind": "field",
13741
- "name": "validity",
13742
- "description": "Returns `'valid'` if all required and interacted-with form elements are valid, `'invalid'` if any are not, or `null` if the form has not been interacted with yet.",
13743
- "return": {
13744
- "type": {
13745
- "text": "\"valid\" | \"invalid\" | null"
13746
- }
13747
- },
13748
- "readonly": true
13749
- },
13750
- {
13751
- "kind": "method",
13752
- "name": "_setInitialState",
13753
- "description": "Determines whether the form is in its initial (untouched) state and updates `_isInitialState` accordingly.",
13754
- "return": {
13755
- "type": {
13756
- "text": "void"
13757
- }
13758
- },
13759
- "privacy": "private"
13760
- },
13761
- {
13762
- "kind": "field",
13763
- "name": "isInitialState",
13764
- "description": "Returns `true` if no form element has been interacted with or had its value changed since the form was initialized or last reset.",
13765
- "return": {
13766
- "type": {
13767
- "text": "boolean"
13768
- }
13769
- },
13770
- "readonly": true
13771
- },
13772
- {
13773
- "kind": "method",
13774
- "name": "setDisabledStateOnButtons",
13775
- "description": "Enables or disables submit and reset buttons based on the current form state and validity.",
13776
- "return": {
13777
- "type": {
13778
- "text": "void"
13779
- }
13780
- },
13781
- "privacy": "private"
13782
- },
13783
- {
13784
- "kind": "method",
13785
- "name": "queryAuroElements",
13786
- "description": "Construct the query strings from elements, append them together, execute, and return the NodeList.",
13787
- "return": {
13788
- "type": {
13789
- "text": "NodeList"
13790
- }
13791
- },
13792
- "privacy": "private"
13793
- },
13794
- {
13795
- "kind": "method",
13796
- "name": "_addElementToState",
13797
- "parameters": [
13798
- {
13799
- "name": "element",
13800
- "description": "The element to add to our state.",
13801
- "type": {
13802
- "text": "HTMLElement"
13803
- }
13804
- }
13805
- ],
13806
- "description": "Store an element in state and on the _elements array.",
13807
- "privacy": "private"
13808
- },
13809
- {
13810
- "kind": "method",
13811
- "name": "initializeState",
13812
- "description": "Initialize (or reinitialize) the form state.",
13813
- "return": {
13814
- "type": {
13815
- "text": "void"
13816
- }
13817
- },
13818
- "privacy": "private"
13819
- },
13820
- {
13821
- "kind": "method",
13822
- "name": "reset",
13823
- "description": "Resets all form elements to their initial state and fires a `reset` event. The event's `detail.previousValue` contains the form values captured immediately before the reset.",
13824
- "return": {
13825
- "type": {
13826
- "text": "void"
13827
- }
13828
- }
13829
- },
13830
- {
13831
- "kind": "method",
13832
- "name": "submit",
13833
- "description": "Validates all form elements. If all are valid, fires a `submit` event with `detail.value` containing the current form values. If any element is invalid, its error state is surfaced and the `submit` event is not fired.",
13834
- "return": {
13835
- "type": {
13836
- "text": "Promise<void>"
13837
- }
13838
- }
13839
- },
13950
+ ]
13951
+ },
13952
+ {
13953
+ "kind": "javascript-module",
13954
+ "path": "components/input/src/index.js",
13955
+ "declarations": [],
13956
+ "exports": [
13957
+ {
13958
+ "kind": "js",
13959
+ "name": "AuroInput",
13960
+ "declaration": {
13961
+ "name": "AuroInput",
13962
+ "module": "components/input/src/index.js"
13963
+ }
13964
+ }
13965
+ ]
13966
+ },
13967
+ {
13968
+ "kind": "javascript-module",
13969
+ "path": "components/input/src/registered.js",
13970
+ "declarations": [],
13971
+ "exports": []
13972
+ },
13973
+ {
13974
+ "kind": "javascript-module",
13975
+ "path": "components/input/src/utilities.js",
13976
+ "declarations": [
13977
+ {
13978
+ "kind": "class",
13979
+ "description": "",
13980
+ "name": "AuroInputUtilities",
13981
+ "members": [
13840
13982
  {
13841
13983
  "kind": "method",
13842
- "name": "register",
13843
- "static": true,
13984
+ "name": "getMaskOptions",
13844
13985
  "parameters": [
13845
13986
  {
13846
- "name": "name",
13847
- "default": "\"auro-form\"",
13848
- "description": "The custom element tag name to register.",
13849
- "optional": true,
13987
+ "name": "type",
13988
+ "description": "The input type.",
13850
13989
  "type": {
13851
13990
  "text": "string"
13852
13991
  }
13853
- }
13854
- ],
13855
- "description": "Registers the `auro-form` custom element with the browser under a given tag name."
13856
- },
13857
- {
13858
- "kind": "method",
13859
- "name": "sharedInputListener",
13860
- "parameters": [
13992
+ },
13861
13993
  {
13862
- "name": "event",
13863
- "description": "The event that is fired from the form element.",
13994
+ "name": "format",
13995
+ "description": "The format of the mask to apply.",
13864
13996
  "type": {
13865
- "text": "Event"
13997
+ "text": "string"
13866
13998
  }
13867
13999
  }
13868
14000
  ],
13869
- "description": "Shared input listener for all form elements.",
13870
- "privacy": "private"
14001
+ "description": "Configures the mask to be used on the input element based on format and/or type.\nIMask tool documentation: https://imask.js.org/.",
14002
+ "privacy": "private",
14003
+ "return": {
14004
+ "type": {
14005
+ "text": "void"
14006
+ }
14007
+ }
13871
14008
  },
13872
14009
  {
13873
14010
  "kind": "method",
13874
- "name": "sharedValidationListener",
14011
+ "name": "toNorthAmericanFormat",
13875
14012
  "parameters": [
13876
14013
  {
13877
- "name": "event",
13878
- "description": "The event that is fired from the form element.",
14014
+ "name": "dateStr",
14015
+ "description": "Date string to format.",
13879
14016
  "type": {
13880
- "text": "Event"
14017
+ "text": "string"
13881
14018
  }
13882
- }
13883
- ],
13884
- "description": "Shared validation listener for all form elements.",
13885
- "privacy": "private"
13886
- },
13887
- {
13888
- "kind": "method",
13889
- "name": "handleKeyDown",
13890
- "parameters": [
14019
+ },
13891
14020
  {
13892
- "name": "event",
13893
- "description": "The keyboard event.",
14021
+ "name": "format",
14022
+ "description": "Date format to use.",
13894
14023
  "type": {
13895
- "text": "KeyboardEvent"
14024
+ "text": "string"
13896
14025
  }
13897
14026
  }
13898
14027
  ],
13899
- "description": "Handle Enter key press on form elements.",
13900
- "privacy": "private"
13901
- },
13902
- {
13903
- "kind": "method",
13904
- "name": "_attachEventListeners",
13905
- "description": "Attaches input, validation, and keydown listeners to all tracked form and button elements.\nRemoves existing listeners first to avoid duplicates on re-initialization.",
13906
- "return": {
13907
- "type": {
13908
- "text": "void"
13909
- }
13910
- },
13911
- "privacy": "private"
13912
- },
13913
- {
13914
- "kind": "method",
13915
- "name": "mutationEventListener",
13916
- "description": "Mutation observer for form elements. Slot change does not trigger unless\nroot-level elements are added/removed. This is a workaround to ensure\nnested form elements are also observed.",
14028
+ "privacy": "private",
13917
14029
  "return": {
13918
14030
  "type": {
13919
14031
  "text": "void"
13920
14032
  }
13921
- },
13922
- "privacy": "private"
14033
+ }
13923
14034
  },
13924
14035
  {
13925
14036
  "kind": "method",
13926
- "name": "onSlotChange",
14037
+ "name": "parseDate",
13927
14038
  "parameters": [
13928
14039
  {
13929
- "name": "event",
13930
- "description": "The slot change event.",
14040
+ "name": "dateStr",
14041
+ "description": "Date string to parse.",
13931
14042
  "type": {
13932
- "text": "Event"
14043
+ "text": "string"
14044
+ }
14045
+ },
14046
+ {
14047
+ "name": "format",
14048
+ "description": "Date format to parse.",
14049
+ "type": {
14050
+ "text": "string"
13933
14051
  }
13934
14052
  }
13935
14053
  ],
13936
- "description": "Slot change event listener. This is the main entry point for the form element.",
14054
+ "privacy": "private",
13937
14055
  "return": {
13938
14056
  "type": {
13939
14057
  "text": "void"
13940
14058
  }
13941
- },
13942
- "privacy": "private"
13943
- },
13944
- {
13945
- "kind": "field",
13946
- "name": "formState",
13947
- "privacy": "private",
13948
- "type": {
13949
- "text": "FormState"
13950
- },
13951
- "default": "{}"
13952
- },
13953
- {
13954
- "kind": "field",
13955
- "name": "_validity",
13956
- "privacy": "private",
13957
- "type": {
13958
- "text": "\"valid\" | \"invalid\" | null"
13959
- },
13960
- "default": "null"
13961
- },
13962
- {
13963
- "kind": "field",
13964
- "name": "_isInitialState",
13965
- "privacy": "private",
13966
- "type": {
13967
- "text": "boolean"
13968
- },
13969
- "default": "true"
13970
- },
13971
- {
13972
- "kind": "field",
13973
- "name": "_elements",
13974
- "privacy": "private",
13975
- "type": {
13976
- "text": "(HTMLElement & {reset: () => void})[]"
13977
- },
13978
- "default": "[]"
13979
- },
13980
- {
13981
- "kind": "field",
13982
- "name": "_submitElements",
13983
- "privacy": "private",
13984
- "type": {
13985
- "text": "HTMLButtonElement[]"
13986
- },
13987
- "default": "[]"
13988
- },
13989
- {
13990
- "kind": "field",
13991
- "name": "_resetElements",
13992
- "privacy": "private",
13993
- "type": {
13994
- "text": "HTMLButtonElement[]"
13995
- },
13996
- "default": "[]"
13997
- },
13998
- {
13999
- "kind": "field",
14000
- "name": "mutationObservers",
14001
- "type": {
14002
- "text": "MutationObserver[]"
14003
- },
14004
- "privacy": "private",
14005
- "default": "[]"
14006
- }
14007
- ],
14008
- "events": [
14009
- {
14010
- "name": "change",
14011
- "type": {
14012
- "text": "Event"
14013
- },
14014
- "description": "Fires when a child form element's value changes or the form is initialized."
14015
- },
14016
- {
14017
- "name": "reset",
14018
- "type": {
14019
- "text": "CustomEvent"
14020
- },
14021
- "description": "Fires when the form is reset. The event detail contains the previous value of the form before reset."
14022
- },
14023
- {
14024
- "name": "submit",
14025
- "type": {
14026
- "text": "CustomEvent"
14027
- },
14028
- "description": "Fires when the form is submitted. The event detail contains the current value of the form."
14029
- },
14030
- {
14031
- "description": "Fires when a child form element receives user input.",
14032
- "name": "input"
14059
+ }
14033
14060
  }
14034
- ],
14035
- "superclass": {
14036
- "name": "LitElement",
14037
- "package": "lit"
14038
- },
14039
- "tagName": "auro-form",
14040
- "customElement": true
14061
+ ]
14041
14062
  }
14042
14063
  ],
14043
14064
  "exports": [
14044
14065
  {
14045
14066
  "kind": "js",
14046
- "name": "AuroForm",
14047
- "declaration": {
14048
- "name": "AuroForm",
14049
- "module": "components/form/src/auro-form.js"
14050
- }
14051
- }
14052
- ]
14053
- },
14054
- {
14055
- "kind": "javascript-module",
14056
- "path": "components/form/src/index.js",
14057
- "declarations": [],
14058
- "exports": [
14059
- {
14060
- "kind": "js",
14061
- "name": "AuroForm",
14067
+ "name": "AuroInputUtilities",
14062
14068
  "declaration": {
14063
- "name": "AuroForm",
14064
- "module": "components/form/src/index.js"
14069
+ "name": "AuroInputUtilities",
14070
+ "module": "components/input/src/utilities.js"
14065
14071
  }
14066
14072
  }
14067
14073
  ]
14068
14074
  },
14069
- {
14070
- "kind": "javascript-module",
14071
- "path": "components/form/src/registered.js",
14072
- "declarations": [],
14073
- "exports": []
14074
- },
14075
14075
  {
14076
14076
  "kind": "javascript-module",
14077
14077
  "path": "components/layoutElement/src/auroElement.js",