@spectrum-web-components/card 1.3.0-beta.6 → 1.3.0

package/README.md

@@ -1,4 +1,4 @@
-## Description
+## Overview
 
 An `<sp-card>` represents a rectangular card that contains
 a variety of text and image layouts. Cards are typically used
@@ -27,29 +27,40 @@ When looking to leverage the `Card` base class as a type and/or for extension pu
 import { Card } from '@spectrum-web-components/card';
 ```
 
-## Example
+### Anatomy
+
+Normal cards can contain a heading, a subheading, a cover photo, and a footer.
 
 ```html demo
-<sp-card heading="Card Heading" subheading="JPG Photo">
-    <img
-        slot="cover-photo"
-        src="https://picsum.photos/200/300"
-        alt="Demo Image"
-    />
+<sp-card heading="Card Heading">
+    <img alt="" slot="cover-photo" src="https://picsum.photos/250/300" />
+    <span slot="subheading">JPG photo</span>
     <div slot="footer">Footer</div>
 </sp-card>
 ```
 
+#### Heading
+
+By default, the heading for an `<sp-card>` is applied via the `heading` attribute, which is restricted to string content only. For HTML content, use the `heading` slot instead.
+
+<sp-tabs selected="heading-attribute" auto label="Heading">
+<sp-tab value="heading-attribute">attribute</sp-tab>
+<sp-tab-panel value="heading-attribute">
+
 ```html demo
-<sp-card heading="Card Title" subheading="JPG">
-    <img slot="preview" src="https://picsum.photos/200/300" alt="Demo Image" />
+<sp-card
+    heading="Card Heading"
+    subheading="JPG Photo"
+    style="--spectrum-card-body-header-height: auto;"
+>
+    <img alt="" slot="cover-photo" src="https://picsum.photos/250/300" />
     <div slot="footer">Footer</div>
 </sp-card>
 ```
 
-## Heading
-
-By default, the heading for an `<sp-card>` is applied via the `heading` attribute, which is restricted to string content only. For HTML content, use the `heading` slot instead.
+</sp-tab-panel>
+<sp-tab value="heading-slot">slot</sp-tab>
+<sp-tab-panel value="heading-slot">
 
 ```html demo
 <sp-card
@@ -57,45 +68,70 @@ By default, the heading for an `<sp-card>` is applied via the `heading` attribut
     style="--spectrum-card-body-header-height: auto;"
 >
     <h1 slot="heading">Card Heading</h1>
-    <img alt="" slot="cover-photo" src="https://picsum.photos/200/300" />
+    <img alt="" slot="cover-photo" src="https://picsum.photos/250/300" />
     <div slot="footer">Footer</div>
 </sp-card>
 ```
 
-## Linking
+</sp-tab-panel>
+</sp-tabs>
+
+#### Linking
 
 An `<sp-card>` can be provided with an `href` attribute in order for it to act as one large anchor element. When leveraging the `href` attribute, the `download`, `target` and `rel` attributes customize the card's linking behavior. Use them as follows:
 
-<!-- prettier-ignore -->
-```html
+```html demo
 <sp-card
     heading="Card Title"
     subheading="JPG"
     href="https://opensource.adobe.com/spectrum-web-components"
     target="_blank"
 >
-    <img slot="cover-photo" src="https://picsum.photos/200/300" alt="Demo Image" />
+    <img
+        slot="cover-photo"
+        src="https://picsum.photos/200/300"
+        alt="Demo Image"
+    />
 </sp-card>
 ```
 
-## Variants
+#### Cover Photo
 
-There are multiple card variants to choose from in Spectrum. The `variant`
-attribute controls the main variant of the card.
+Use `slot="cover-photo"` on an image to set it as the card's cover photo.
 
-### Normal
+```html demo
+<sp-card heading="Card Heading" subheading="JPG Photo">
+    <img
+        slot="cover-photo"
+        src="https://picsum.photos/200/300"
+        alt="Demo Image"
+    />
+    <div slot="footer">Footer</div>
+</sp-card>
+```
 
-Normal cards can contain a heading, a subheading, a cover photo, and a footer.
+#### Preview Image
 
-```html
-<sp-card heading="Card Heading">
-    <img alt="" slot="cover-photo" src="https://picsum.photos/200/300" />
-    <span slot="subheading">JPG photo</span>
+Use `slot="preview"` on an image to set it as the card's preview image.
+
+```html demo
+<sp-card heading="Card Title" subheading="JPG">
+    <img slot="preview" src="https://picsum.photos/200/300" alt="Demo Image" />
     <div slot="footer">Footer</div>
 </sp-card>
 ```
 
-### Actions
+#### No Preview Image
+
+Cards with no preview image can contain a heading, a subheading, and a footer.
+
+```html demo
+<sp-card heading="Card Title" subheading="No Preview Image">
+    <div slot="footer">Footer</div>
+</sp-card>
+```
+
+#### Actions
 
 Cards can be supplied an `actions` via a names slot.
 
@@ -124,168 +160,88 @@ Cards can be supplied an `actions` via a names slot.
 </sp-card>
 ```
 
-### No Preview Image
+### Options
 
-Cards with no preview image can contain a heading, a subheading, and a footer.
+#### Horizontal
 
-```html demo
-<sp-card heading="Card Title" subheading="No Preview Image">
-    <div slot="footer">Footer</div>
+Cards with a `horizontal` attribute can contain a heading, a subheading, a cover photo, and a description.
+
+```html
+<sp-card horizontal heading="Card Heading" subheading="JPG Photo">
+    <img alt="" slot="cover-photo" src="https://picsum.photos/200/250" />
+    <div slot="description">10/15/18</div>
 </sp-card>
 ```
 
-### Quiet
+#### Variant
 
-Quiet cards can contain a heading, a subheading, a cover photo, a description, and a footer.
+There are multiple card variants to choose from in Spectrum. The `variant`
+attribute controls the main variant of the card.
 
-```html
-<div style="width: 208px; height: 264px">
-    <sp-card variant="quiet" heading="Card Heading" subheading="JPG Photo">
-        <img alt="" slot="preview" src="https://picsum.photos/200/300" />
-        <div slot="description">10/15/18</div>
-        <div slot="footer">Footer</div>
-    </sp-card>
-</div>
-```
+Cards with `variant="quiet"` can contain a heading, a subheading, a cover photo, a description, and a footer. Quiet cards will also accept `actions` via a named slot.
 
-When leveraging the `asset` attribute, a card can be declared as representing a `file`:
+<!--
+TODO: Address example below when https://github.com/adobe/spectrum-web-components/issues/4945 is addressed.
+-->
 
 ```html
-<div style="width: 208px; height: 264px">
-    <sp-card
-        variant="quiet"
-        heading="Card Heading"
-        subheading="JPG Photo"
-        asset="file"
+<sp-card variant="quiet" heading="Card Heading" subheading="JPG Photo">
+    <img alt="" slot="preview" src="https://picsum.photos/200/350" />
+    <div slot="description">10/15/18</div>
+    <sp-action-menu
+        label="More Actions"
+        slot="actions"
+        placement="bottom-end"
+        quiet
     >
-        <img alt="" slot="preview" src="https://picsum.photos/200/300" />
-        <div slot="heading">File Name</div>
-        <div slot="description">10/15/18</div>
-        <div slot="footer">Footer</div>
-    </sp-card>
-</div>
-```
-
-Or a `folder`:
-
-```html
-<div style="width: 208px; height: 264px">
-    <sp-card variant="quiet" subheading="JPG Photo" asset="folder">
-        <img alt="" slot="preview" src="https://picsum.photos/200/300" />
-        <div slot="heading">Folder Name</div>
-        <div slot="description">10/15/18</div>
-        <div slot="footer">Footer</div>
-    </sp-card>
-</div>
+        <sp-menu-item>Deselect</sp-menu-item>
+        <sp-menu-item>Select Inverse</sp-menu-item>
+        <sp-menu-item>Feather...</sp-menu-item>
+        <sp-menu-item>Select and Mask...</sp-menu-item>
+        <sp-menu-divider></sp-menu-divider>
+        <sp-menu-item>Save Selection</sp-menu-item>
+        <sp-menu-item disabled>Make Work Path</sp-menu-item>
+    </sp-action-menu>
+</sp-card>
 ```
 
-Quiet cards will also accept `actions` via a named slot.
+Cards with `variant="gallery"` can contain a heading, a subheading, an image preview, a description, and a footer.
 
 ```html
-<div style="width: 208px; height: 264px">
-    <sp-card variant="quiet" heading="Card Heading" subheading="JPG Photo">
-        <img alt="" slot="preview" src="https://picsum.photos/200/300" />
-        <div slot="description">10/15/18</div>
-        <sp-action-menu
-            label="More Actions"
-            slot="actions"
-            placement="bottom-end"
-            quiet
-        >
-            <sp-menu-item>Deselect</sp-menu-item>
-            <sp-menu-item>Select Inverse</sp-menu-item>
-            <sp-menu-item>Feather...</sp-menu-item>
-            <sp-menu-item>Select and Mask...</sp-menu-item>
-            <sp-menu-divider></sp-menu-divider>
-            <sp-menu-item>Save Selection</sp-menu-item>
-            <sp-menu-item disabled>Make Work Path</sp-menu-item>
-        </sp-action-menu>
-    </sp-card>
-</div>
+<sp-card variant="gallery" heading="Card Heading" subheading="JPG Photo">
+    <img alt="" slot="preview" src="https://picsum.photos/532/192" />
+    <div slot="description">10/15/18</div>
+    <div slot="footer">Footer</div>
+</sp-card>
 ```
 
-### Gallery
+#### Asset
 
-Gallery cards can contain a heading, a subheading, an image preview, a description, and a footer.
+When leveraging the `asset` attribute, a card can be declared as representing a `file` or a `folder`:
 
 ```html
-<div style="width: 532px; max-width: 100%; height: 224px">
-    <sp-card variant="gallery" heading="Card Heading" subheading="JPG Photo">
-        <img alt="" slot="preview" src="https://picsum.photos/532/192" />
-        <div slot="description">10/15/18</div>
-        <div slot="footer">Footer</div>
-    </sp-card>
-</div>
+<sp-card heading="Card Heading" subheading="JPG Photo" asset="file">
+    <div slot="heading">File Name</div>
+    <div slot="description">10/15/18</div>
+    <div slot="footer">Footer</div>
+</sp-card>
+<sp-card subheading="JPG Photo" asset="folder">
+    <div slot="heading">Folder Name</div>
+    <div slot="description">10/15/18</div>
+    <div slot="footer">Footer</div>
+</sp-card>
 ```
 
-### Size
+### Accessibility
 
-`size="s"` will delivery the `<sp-card>` element at a "small" size. It can be leveraged with a standard card:
+#### Be concise
 
-```html demo
-<div style="width: 208px; height: 264px">
-    <sp-card size="s" heading="Card Heading" subheading="JPG Photo">
-        <img
-            slot="cover-photo"
-            alt="Demo Image"
-            src="https://picsum.photos/110"
-        />
-        <div slot="footer">Footer</div>
-    </sp-card>
-</div>
-```
+Heading text should be no more than 5-7 words. If the card has an `href`, the heading is used as a link and should ideally be no more than 3 words. For buttons, 1-2 words.
 
-A `horizontal` card:
+#### Use descriptive heading, link, and button text
 
-```html demo
-<div style="color: var(--spectrum-neutral-content-color-default);">
-    <sp-card size="s" horizontal heading="Card Heading" subheading="JPG Photo">
-        <sp-icon slot="preview" style="width: 36px; height: 36px;">
-            <svg
-                xmlns="http://www.w3.org/2000/svg"
-                viewBox="0 0 36 36"
-                aria-hidden="true"
-                role="img"
-                fill="currentColor"
-            >
-                <path d="M20 2v10h10L20 2z" />
-                <path
-                    d="M19 14a1 1 0 01-1-1V2H7a1 1 0 00-1 1v30a1 1 0 001 1h22a1 1 0 001-1V14zm7 15.5a.5.5 0 01-.5.5h-15a.5.5 0 01-.5-.5v-1a.5.5 0 01.5-.5h15a.5.5 0 01.5.5zm0-4a.5.5 0 01-.5.5h-15a.5.5 0 01-.5-.5v-1a.5.5 0 01.5-.5h15a.5.5 0 01.5.5zm0-4a.5.5 0 01-.5.5h-15a.5.5 0 01-.5-.5v-1a.5.5 0 01.5-.5h15a.5.5 0 01.5.5z"
-                />
-            </svg>
-        </sp-icon>
-    </sp-card>
-</div>
-```
+Be descriptive. Set expectations on what someone will find and where they will go once they interact with a card. Avoid using the same text on more than one interactive element, unless both elements go to the same place.
 
-Or a `quiet` card:
+#### Make the first word in a heading meaningful
 
-```html demo
-<div
-    style="color: var(--spectrum-neutral-content-color-default); width: 110px;"
->
-    <sp-card
-        size="s"
-        heading="Card Heading"
-        subheading="JPG Photo"
-        variant="quiet"
-    >
-        <img src="https://picsum.photos/110" alt="Demo Image" slot="preview" />
-        <div slot="footer">Footer</div>
-        <sp-action-menu
-            label="More Actions"
-            slot="actions"
-            placement="bottom-end"
-            quiet
-        >
-            <sp-menu-item>Deselect</sp-menu-item>
-            <sp-menu-item>Select Inverse</sp-menu-item>
-            <sp-menu-item>Feather...</sp-menu-item>
-            <sp-menu-item>Select and Mask...</sp-menu-item>
-            <sp-menu-divider></sp-menu-divider>
-            <sp-menu-item>Save Selection</sp-menu-item>
-            <sp-menu-item disabled>Make Work Path</sp-menu-item>
-        </sp-action-menu>
-    </sp-card>
-</div>
-```
+Consider making the first word of links, buttons and headings something an assistive technology user might search for when headings and links are listed alphabetically.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/card",
-    "version": "1.3.0-beta.6",
+    "version": "1.3.0",
     "publishConfig": {
         "access": "public"
     },
@@ -58,13 +58,13 @@
         "lit-html"
     ],
     "dependencies": {
-        "@spectrum-web-components/asset": "^1.3.0-beta.6",
-        "@spectrum-web-components/base": "^1.3.0-beta.6",
-        "@spectrum-web-components/checkbox": "^1.3.0-beta.6",
-        "@spectrum-web-components/divider": "^1.3.0-beta.6",
-        "@spectrum-web-components/icons-workflow": "^1.3.0-beta.6",
-        "@spectrum-web-components/shared": "^1.3.0-beta.6",
-        "@spectrum-web-components/styles": "^1.3.0-beta.6"
+        "@spectrum-web-components/asset": "1.3.0",
+        "@spectrum-web-components/base": "1.3.0",
+        "@spectrum-web-components/checkbox": "1.3.0",
+        "@spectrum-web-components/divider": "1.3.0",
+        "@spectrum-web-components/icons-workflow": "1.3.0",
+        "@spectrum-web-components/shared": "1.3.0",
+        "@spectrum-web-components/styles": "1.3.0"
     },
     "devDependencies": {
         "@spectrum-css/card": "10.0.0-s2-foundations.20"
@@ -74,6 +74,5 @@
     "sideEffects": [
         "./sp-*.js",
         "./**/*.dev.js"
-    ],
-    "gitHead": "7a244ef2b2cad9f06962483af6fdff89828d9a83"
+    ]
 }

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.