@aurodesignsystem-dev/auro-card 0.0.0-pr130.0 → 0.0.0-pr130.1

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 (9) hide show
  1. package/custom-elements.json +649 -0
  2. package/demo/api.md +35 -34
  3. package/demo/auro-card.min.js +249 -2562
  4. package/dist/auro-card-BdEhjPlf.js +141 -0
  5. package/dist/index.d.ts +35 -18
  6. package/dist/index.js +1 -1
  7. package/dist/registered.js +1 -1
  8. package/package.json +10 -6
  9. package/dist/auro-card-Ck8vwzfh.js +0 -124
package/demo/api.md CHANGED
@@ -5,44 +5,45 @@
5
5
 
6
6
  The `<auro-card>` element provides users a flexible way to convey a summary of information.
7
7
 
8
- ## Attributes
8
+ ### Properties & Attributes
9
9
 
10
- | Attribute | Type | Description |
11
- |-----------|-----------|--------------------------------------------------|
12
- | [border](#border) | `Boolean` | Adds desired UI border to the `auro-card` element. |
13
- | [center](#center) | `Boolean` | Centers content within the scope of the `auro-card`. |
14
-
15
- ## Properties
16
-
17
- | Property | Attribute | Type | Description |
18
- |------------|------------|-----------|--------------------------------------------------|
19
- | [href](#href) | `href` | `String` | Sets the card to function as a hyperlink to the provided href value & disables the default CTA slot. |
20
- | [rel](#rel) | `rel` | `String` | Sets rel attribute on the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#rel). |
21
- | [relative](#relative) | `relative` | `Boolean` | If true, the auto URL re-write feature will be disabled.https://auro.alaskaair.com/components/auro/hyperlink/api#relative |
22
- | [role](#role) | `role` | `String` | Sets role attribute on the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#role). |
23
- | [target](#target) | `target` | `String` | Sets target attribute on the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#target). |
24
- | [variant](#variant) | `variant` | `String` | Sets the variant of the card. Options `inset-content`, `inset-container`, `inset-stretch`. |
25
-
26
- ## Slots
10
+ | Properties | Attributes | Type | Default | Description |
11
+ | --- | --- | --- | --- | --- |
12
+ variant | variant | string | | Sets the variant of the card. Options `inset-content`, `inset-container`, `inset-stretch`.
13
+ href | href | string | | Sets the card to function as a hyperlink to the provided href value & disables the default CTA slot.
14
+ rel | rel | string | | Sets rel attribute on the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#rel).
15
+ relative | relative | boolean | | If true, the auto URL re-write feature will be disabled. [see here for hyperlink relative](https://auro.alaskaair.com/components/auro/hyperlink/api#relative)
16
+ role | role | string | | Sets role attribute on the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#role).
17
+ target | target | string | | Sets target attribute on the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#target).
18
+ | border | Boolean | | Adds desired UI border to the `auro-card` element.
19
+ | center | Boolean | | Centers content within the scope of the `auro-card`.
20
+
21
+ ### Methods
27
22
 
28
- | Name | Description |
29
- |---------------|--------------------------------------------------|
30
- | [cta](#cta) | Content slot for call-to-action content. |
31
- | [description](#description) | Content slot for string text description content. |
32
- | [header](#header) | Content slot for string text header content. |
33
- | [image](#image) | Content slot for image content. |
23
+ | Name | Parameters | Return | Description |
24
+ | --- | --- | --- | --- |
25
+ register | `name` (string) - The name of element that you want to register to. | | This will register this element with the browser.
26
+
27
+ ### Slots
34
28
 
35
- ## CSS Shadow Parts
29
+ | Name | Description |
30
+ | --- | --- |
31
+ image | Content slot for image content.
32
+ header | Content slot for string text header content.
33
+ description | Content slot for string text description content.
34
+ cta | Content slot for call-to-action content.
35
+
36
+ ### CSS Shadow Parts
36
37
 
37
- | Part | Description |
38
- |----------------|--------------------------------------------------|
39
- | [content](#content) | Apply styles to the outer string text container. |
40
- | [cta](#cta) | Apply styles to the named cta slot container. |
41
- | [description](#description) | Apply styles to the named description slot container. |
42
- | [header](#header) | Apply styles to the named header slot container. |
43
- | [image](#image) | Apply styles to the named image slot container. |
44
- | [imageWrapper](#imageWrapper) | Apply styles to the outer image slot container. |
45
- | [link](#link) | Apply styles to the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#link) element. |
38
+ | Name | Description |
39
+ | --- | --- |
40
+ content | Apply styles to the outer string text container.
41
+ link | Apply styles to the [auro-hyperlink](https://auro.alaskaair.com/components/auro/hyperlink/api#link) element.
42
+ imageWrapper | Apply styles to the outer image slot container.
43
+ image | Apply styles to the named image slot container.
44
+ header | Apply styles to the named header slot container.
45
+ description | Apply styles to the named description slot container.
46
+ cta | Apply styles to the named cta slot container.
46
47
  <!-- AURO-GENERATED-CONTENT:END -->
47
48
 
48
49
  ## API Examples