@aurodesignsystem-dev/auro-formkit 0.0.0-pr1451.13 → 0.0.0-pr1451.14
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.
- package/components/checkbox/demo/api.min.js +3 -3
- package/components/checkbox/demo/index.min.js +3 -3
- package/components/checkbox/dist/index.js +3 -3
- package/components/checkbox/dist/registered.js +3 -3
- package/components/combobox/README.md +8 -29
- package/components/combobox/demo/accessibility.html +2 -20
- package/components/combobox/demo/accessibility.md +1 -1
- package/components/combobox/demo/api.min.js +10 -9
- package/components/combobox/demo/customize.md +180 -30
- package/components/combobox/demo/customize.min.js +30 -28
- package/components/combobox/demo/design.html +2 -43
- package/components/combobox/demo/design.md +4 -4
- package/components/combobox/demo/getting-started.md +51 -39
- package/components/combobox/demo/getting-started.min.js +9 -9
- package/components/combobox/demo/index.md +3 -2
- package/components/combobox/demo/index.min.js +10 -9
- package/components/combobox/demo/keyboard-behavior.html +2 -20
- package/components/combobox/demo/keyboard-behavior.md +2 -2
- package/components/combobox/demo/layout.md +2 -2
- package/components/combobox/demo/readme.html +2 -43
- package/components/combobox/demo/readme.md +8 -29
- package/components/combobox/demo/styles.css +1 -1
- package/components/combobox/demo/voiceover.html +2 -20
- package/components/combobox/dist/index.js +7 -7
- package/components/combobox/dist/registered.js +7 -7
- package/components/counter/demo/api.min.js +6 -6
- package/components/counter/demo/index.min.js +6 -6
- package/components/counter/demo/keyboard-behavior.md +1 -1
- package/components/counter/dist/index.js +6 -6
- package/components/counter/dist/registered.js +6 -6
- package/components/datepicker/demo/api.min.js +11 -11
- package/components/datepicker/demo/index.min.js +11 -11
- package/components/datepicker/dist/index.js +11 -11
- package/components/datepicker/dist/registered.js +11 -11
- package/components/dropdown/demo/api.min.js +2 -2
- package/components/dropdown/demo/index.min.js +2 -2
- package/components/dropdown/demo/keyboard-behavior.md +1 -1
- package/components/dropdown/dist/index.js +2 -2
- package/components/dropdown/dist/registered.js +2 -2
- package/components/form/demo/api.min.js +40 -40
- package/components/form/demo/index.min.js +40 -40
- package/components/helptext/dist/index.js +1 -1
- package/components/helptext/dist/registered.js +1 -1
- package/components/input/README.md +17 -28
- package/components/input/demo/accessibility.html +38 -0
- package/components/input/demo/accessibility.md +69 -0
- package/components/input/demo/api.html +17 -22
- package/components/input/demo/api.js +4 -23
- package/components/input/demo/api.md +0 -1200
- package/components/input/demo/api.min.js +3 -95
- package/components/input/demo/customize.html +54 -0
- package/components/input/demo/customize.js +25 -0
- package/components/input/demo/customize.md +1372 -0
- package/components/input/demo/customize.min.js +7430 -0
- package/components/input/demo/demo-support.js +60 -0
- package/components/input/demo/design.html +39 -0
- package/components/input/demo/design.md +224 -0
- package/components/input/demo/getting-started.html +53 -0
- package/components/input/demo/getting-started.js +8 -0
- package/components/input/demo/getting-started.md +312 -0
- package/components/input/demo/getting-started.min.js +7368 -0
- package/components/input/demo/index.html +16 -22
- package/components/input/demo/index.js +0 -11
- package/components/input/demo/index.md +171 -139
- package/components/input/demo/index.min.js +3 -15
- package/components/input/demo/keyboard-behavior.html +38 -0
- package/components/input/demo/layout.md +77 -0
- package/components/input/demo/readme.md +17 -28
- package/components/input/demo/styles.css +974 -0
- package/components/input/demo/voiceover.html +38 -0
- package/components/input/demo/voiceover.md +70 -0
- package/components/input/dist/index.js +3 -3
- package/components/input/dist/registered.js +3 -3
- package/components/menu/demo/api.min.js +2 -2
- package/components/menu/demo/index.min.js +2 -2
- package/components/menu/dist/index.js +2 -2
- package/components/menu/dist/registered.js +2 -2
- package/components/radio/demo/api.min.js +3 -3
- package/components/radio/demo/index.min.js +3 -3
- package/components/radio/dist/index.js +3 -3
- package/components/radio/dist/registered.js +3 -3
- package/components/select/README.md +7 -4
- package/components/select/demo/accessibility.md +1 -1
- package/components/select/demo/customize.js +1 -13
- package/components/select/demo/customize.md +158 -1
- package/components/select/demo/customize.min.js +9 -9
- package/components/select/demo/design.md +2 -2
- package/components/select/demo/getting-started.js +1 -3
- package/components/select/demo/getting-started.md +53 -18
- package/components/select/demo/getting-started.min.js +9 -9
- package/components/select/demo/index.html +2 -0
- package/components/select/demo/index.js +5 -3
- package/components/select/demo/index.md +2 -2
- package/components/select/demo/index.min.js +14 -9
- package/components/select/demo/keyboard-behavior.md +3 -3
- package/components/select/demo/readme.md +7 -4
- package/components/select/demo/styles.css +1 -1
- package/components/select/dist/index.js +5 -5
- package/components/select/dist/registered.js +5 -5
- package/package.json +2 -2
- package/components/combobox/demo/install.html +0 -94
- package/components/combobox/demo/install.js +0 -24
- package/components/combobox/demo/install.md +0 -98
- package/components/combobox/demo/install.min.js +0 -17992
- package/components/select/demo/install.md +0 -92
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
<auro-header level="1" id="install">Install</auro-header>
|
|
2
|
-
<auro-header level="2" id="npmInstall">NPM Installation</auro-header>
|
|
3
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/componentInstall.md) -->
|
|
4
|
-
<!-- The below content is automatically added from ./../../../docs/templates/componentInstall.md -->
|
|
5
|
-
|
|
6
|
-
<pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
|
|
7
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
8
|
-
<auro-header level="2" id="gettingStarted">Getting Started</auro-header>
|
|
9
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/gettingStarted.md) -->
|
|
10
|
-
<!-- The below content is automatically added from ./../../../docs/templates/gettingStarted.md -->
|
|
11
|
-
|
|
12
|
-
### TypeScript Module Resolution
|
|
13
|
-
|
|
14
|
-
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
15
|
-
|
|
16
|
-
<pre class="language-json"><code class="language-json">{
|
|
17
|
-
"compilerOptions": {
|
|
18
|
-
"moduleResolution": "bundler"
|
|
19
|
-
}
|
|
20
|
-
}</code></pre>
|
|
21
|
-
|
|
22
|
-
This configuration enables proper module resolution for the component's TypeScript files.
|
|
23
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
24
|
-
<auro-header level="2" id="defaultSetup">Default Component Setup</auro-header>
|
|
25
|
-
Once installed, the component can be used in your project by importing the component's registered module:
|
|
26
|
-
|
|
27
|
-
<pre class="language-js"><code class="language-js">import '@aurodesignsystem/auro-formkit/auro-combobox';</code></pre>
|
|
28
|
-
|
|
29
|
-
This import registers the `<auro-combobox>` custom element globally. You can then use it in your HTML:
|
|
30
|
-
|
|
31
|
-
<pre class="language-html"><code class="language-html"><auro-combobox>
|
|
32
|
-
<span slot="label">Choose an option</span>
|
|
33
|
-
<auro-menu>
|
|
34
|
-
<auro-menuoption value="option1">Option 1</auro-menuoption>
|
|
35
|
-
<auro-menuoption value="option2">Option 2</auro-menuoption>
|
|
36
|
-
</auro-menu>
|
|
37
|
-
</auro-combobox></code></pre>
|
|
38
|
-
|
|
39
|
-
<auro-header level="2" id="cdn">Install from CDN</auro-header>
|
|
40
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/bundleInstallDescription.md) -->
|
|
41
|
-
<!-- The below content is automatically added from ./../../../docs/templates/bundleInstallDescription.md -->
|
|
42
|
-
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
|
|
43
|
-
|
|
44
|
-
<pre class="language-html"><code class="language-html"><script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-combobox/+esm"></script></code></pre>
|
|
45
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
46
|
-
<auro-header level="2" id="customRegistration">Custom Component Registration</auro-header>
|
|
47
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/customRegistration.md) -->
|
|
48
|
-
<!-- The below content is automatically added from ./../docs/partials/customRegistration.md -->
|
|
49
|
-
|
|
50
|
-
## Custom Component Registration for Version Management
|
|
51
|
-
|
|
52
|
-
There are two key parts to every Auro component: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
|
|
53
|
-
|
|
54
|
-
When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
|
|
55
|
-
|
|
56
|
-
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
|
|
57
|
-
|
|
58
|
-
You can do this by importing only the component class and using the `register(name)` method with a unique name:
|
|
59
|
-
|
|
60
|
-
<pre class="language-js"><code class="language-js">// Import the class only
|
|
61
|
-
import { AuroCombobox } from '@aurodesignsystem/auro-formkit/auro-combobox/class';
|
|
62
|
-
|
|
63
|
-
// Register with a custom name if desired
|
|
64
|
-
AuroCombobox.register('custom-combobox');</code></pre>
|
|
65
|
-
|
|
66
|
-
This will create a new custom element `<custom-combobox>` that behaves exactly like `<auro-combobox>`, allowing both to coexist on the same page without interfering with each other.
|
|
67
|
-
|
|
68
|
-
<div class="exampleWrapper exampleWrapper--flex">
|
|
69
|
-
<custom-combobox>
|
|
70
|
-
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
71
|
-
<span slot="label">Name</span>
|
|
72
|
-
<auro-menu>
|
|
73
|
-
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
74
|
-
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
75
|
-
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
76
|
-
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
77
|
-
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
78
|
-
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
79
|
-
</auro-menu>
|
|
80
|
-
</custom-combobox>
|
|
81
|
-
</div>
|
|
82
|
-
<auro-accordion alignRight>
|
|
83
|
-
<span slot="trigger">See code</span>
|
|
84
|
-
|
|
85
|
-
<pre class="language-html"><code class="language-html"><custom-combobox>
|
|
86
|
-
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
87
|
-
<span slot="label">Name</span>
|
|
88
|
-
<auro-menu>
|
|
89
|
-
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
90
|
-
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
91
|
-
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
92
|
-
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
93
|
-
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
94
|
-
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
95
|
-
</auro-menu>
|
|
96
|
-
</custom-combobox></code></pre>
|
|
97
|
-
</auro-accordion>
|
|
98
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|