Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(infield-progress-cirlce): new component, sharing tokens from progress circle #3430

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/flat-snails-admire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@spectrum-css/infieldprogresscircle": major
---

## Infield Progresscircle S2 Migration

In-field progress circle is a new component created to replace progress circle (size S) in t-shirt size components. The button, textfield, combo box, and picker `template.js` files have all been updated to call for infield progress circles. This component comes in four sizes: (S, M, L, XL), has updated color variants (default, white, black), and has a unified track thickness.
17 changes: 7 additions & 10 deletions components/button/stories/template.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Template as Icon } from "@spectrum-css/icon/stories/template.js";
import { Template as InfieldProgressCircle } from "@spectrum-css/infieldprogresscircle/stories/template.js";
import { Container, getRandomId } from "@spectrum-css/preview/decorators";
import { Template as ProgressCircle } from "@spectrum-css/progresscircle/stories/template.js";
import { html } from "lit";
import { classMap } from "lit/directives/class-map.js";
import { ifDefined } from "lit/directives/if-defined.js";
Expand Down Expand Up @@ -89,15 +89,12 @@ export const Template = ({
Icon({ iconName, setName: iconSet, size }, context)
)}
${when(isPending, () =>
ProgressCircle(
{
size: "s",
testId: "progress-circle",
staticColor,
isIndeterminate: true,
},
context
)
InfieldProgressCircle({
size: size,
staticColor,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for removing the testId: "progress-circle" line? Do we no longer need it?

isIndeterminate: true,
testId: "infield-progress-circle"
}, context)
)}
</button>
`;
Expand Down
2 changes: 1 addition & 1 deletion components/combobox/stories/template.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const Combobox = ({
],
customInputClasses: [`${rootClass}-input`],
isLoading,
customProgressCircleClasses: ["spectrum-Combobox-progress-circle"],
customInfieldProgressCircleClasses: ["spectrum-Combobox-progress-circle"],
name: "field",
isReadOnly,
value,
Expand Down
7 changes: 7 additions & 0 deletions components/infieldprogresscircle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# @spectrum-css/infieldprogresscircle

> The Spectrum CSS infield progress circle component

This package is part of the [Spectrum CSS project](https://github.com/adobe/spectrum-css).

See the [Spectrum CSS documentation](https://opensource.adobe.com/spectrum-css/) and [Spectrum CSS on GitHub](https://github.com/adobe/spectrum-css) for details.
25 changes: 25 additions & 0 deletions components/infieldprogresscircle/dist/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"sourceFile": "index.css",
"selectors": [
".spectrum-InfieldProgressCircle",
".spectrum-InfieldProgressCircle .spectrum-ProgressCircle-fill",
".spectrum-InfieldProgressCircle--sizeL",
".spectrum-InfieldProgressCircle--sizeS",
".spectrum-InfieldProgressCircle--sizeXL"
],
"modifiers": [],
"component": [
"--spectrum-in-field-progress-circle-edge-to-fill",
"--spectrum-in-field-progress-circle-size-100",
"--spectrum-in-field-progress-circle-size-200",
"--spectrum-in-field-progress-circle-size-300",
"--spectrum-in-field-progress-circle-size-75",
"--spectrum-infieldprogresscircle-padding-block"
],
"global": ["--spectrum-progress-circle-thickness-small"],
"passthroughs": [
"--mod-progress-circle-size",
"--mod-progress-circle-thickness"
],
"high-contrast": []
}
37 changes: 37 additions & 0 deletions components/infieldprogresscircle/index.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*!
Copyright 2025 Adobe. All rights reserved.
This file is licensed to you 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 REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/

.spectrum-InfieldProgressCircle {
--mod-progress-circle-thickness: var(--spectrum-progress-circle-thickness-small);
--mod-progress-circle-size: var(--spectrum-in-field-progress-circle-size-100);
--spectrum-infieldprogresscircle-padding-block: var(--spectrum-in-field-progress-circle-edge-to-fill);
}

.spectrum-InfieldProgressCircle--sizeS {
--mod-progress-circle-size: var(--spectrum-in-field-progress-circle-size-75);
}

.spectrum-InfieldProgressCircle--sizeL {
--mod-progress-circle-size: var(--spectrum-in-field-progress-circle-size-200);
}

.spectrum-InfieldProgressCircle--sizeXL {
--mod-progress-circle-size: var(--spectrum-in-field-progress-circle-size-300);
}

.spectrum-InfieldProgressCircle {
padding-block: var(--spectrum-infieldprogresscircle-padding-block);

.spectrum-ProgressCircle-fill {
stroke-linecap: square;
}
}
52 changes: 52 additions & 0 deletions components/infieldprogresscircle/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"name": "@spectrum-css/infieldprogresscircle",
"version": "0.0.0",
"description": "The Spectrum CSS infieldprogresscircle component",
"license": "Apache-2.0",
"author": "Adobe",
"homepage": "https://opensource.adobe.com/spectrum-css/?path=/docs/components-in-field-progress-circle--docs",
"repository": {
"type": "git",
"url": "https://github.com/adobe/spectrum-css.git",
"directory": "components/infieldprogresscircle"
},
"bugs": {
"url": "https://github.com/adobe/spectrum-css/issues"
},
"exports": {
".": "./dist/index.css",
"./*.md": "./*.md",
"./dist/*": "./dist/*",
"./index-*.css": "./dist/index-*.css",
"./index.css": "./dist/index.css",
"./metadata.json": "./dist/metadata.json",
"./package.json": "./package.json",
"./stories/*": "./stories/*"
},
"main": "dist/index.css",
"peerDependencies": {
"@spectrum-css/tokens": ">=16"
},
"devDependencies": {
"@spectrum-css/tokens": "16.0.0"
},
"keywords": [
"design-system",
"spectrum",
"spectrum-css",
"adobe",
"adobe-spectrum",
"component",
"css"
],
"publishConfig": {
"access": "public"
},
"spectrum": [
{
"guidelines": "https://spectrum.adobe.com/page/progress-circle",
"rootClass": "spectrum-InfieldProgressCircle",
"swc": "https://opensource.adobe.com/spectrum-web-components/components/progress-circle/"
}
]
}
17 changes: 17 additions & 0 deletions components/infieldprogresscircle/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "../../node_modules/nx/schemas/project-schema.json",
"name": "infieldprogresscircle",
"tags": ["component"],
"targets": {
"build": {},
"clean": {},
"compare": {},
"format": {},
"lint": {},
"report": {},
"test": {
"defaultConfiguration": "scope"
},
"validate": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
import { Sizes } from "@spectrum-css/preview/decorators";
import { disableDefaultModes } from "@spectrum-css/preview/modes";
import { size } from "@spectrum-css/preview/types";
import { default as ProgressCircle } from "@spectrum-css/progresscircle/stories/progresscircle.stories.js";
import metadata from "../dist/metadata.json";
import packageJson from "../package.json";
import { InfieldProgressCircleGroup } from "./infieldprogresscircle.test.js";
import { Template } from "./template.js";

/**
* In-field progress circles are used in t-shirt size components such as [buttons](/docs/components-button--docs), [combo boxes](/docs/components-combobox--docs), and [pickers](/docs/components-picker--docs). The in-field progress circle can be used in place of an icon or in tight spaces when space is limited both vertically and horizontally.
*/

export default {
title: "In-field progress circle",
component: "InfieldProgressCircle",
argTypes: {
...ProgressCircle.argTypes,
size: size(["s", "m", "l", "xl"]),
},
args: {
...ProgressCircle.args,
rootClass: "spectrum-InfieldProgressCircle",
},
parameters: {
...ProgressCircle.parameters,
design: {
type: "figma",
url: "https://www.figma.com/design/eoZHKJH9a3LJkHYCGt60Vb/S2-token-specs?node-id=14970-6050",
},
packageJson,
metadata,
}
};

export const Default = InfieldProgressCircleGroup.bind({});
Default.args = {};

// ********* VRT ONLY ********* //
export const WithForcedColors = InfieldProgressCircleGroup.bind({});
WithForcedColors.args = Default.args;
WithForcedColors.tags = ["!autodocs", "!dev"];
WithForcedColors.parameters = {
chromatic: {
forcedColors: "active",
modes: disableDefaultModes,
},
};

// ********* DOCS ONLY ********* //

export const Sizing = (args, context) => Sizes({
Template,
withHeading: false,
withBorder: false,
...args,
}, context);
Sizing.args = {};
Sizing.tags = ["!dev"];
Sizing.parameters = {
chromatic: { disableSnapshot: true },
};

/**
* The indeterminate progress circle displays a repeating animation for the inner fill.
*/
export const Indeterminate = (args, context) => Sizes({
Template,
withHeading: false,
withBorder: false,
...args,
}, context);
Indeterminate.args = {
isIndeterminate: true,
};
Indeterminate.tags = ["!dev"];
Indeterminate.parameters = {
chromatic: { disableSnapshot: true },
};

export const StaticWhiteDeterminate = Sizing.bind({});
StaticWhiteDeterminate.tags = ["!dev"];
StaticWhiteDeterminate.storyName = "Static white, default";
StaticWhiteDeterminate.args = {
staticColor: "white",
};
StaticWhiteDeterminate.parameters = {
chromatic: { disableSnapshot: true },
};

export const StaticWhiteIndeterminate = Sizing.bind({});
StaticWhiteIndeterminate.tags = ["!dev"];
StaticWhiteIndeterminate.storyName = "Static white, indeterminate";
StaticWhiteIndeterminate.args = {
staticColor: "white",
isIndeterminate: true,
};
StaticWhiteIndeterminate.parameters = {
chromatic: { disableSnapshot: true },
};

export const StaticBlackDeterminate = Sizing.bind({});
StaticBlackDeterminate.tags = ["!dev"];
StaticBlackDeterminate.storyName = "Static black, default";
StaticBlackDeterminate.args = {
staticColor: "black",
};
StaticBlackDeterminate.parameters = {
chromatic: { disableSnapshot: true },
};

export const StaticBlackIndeterminate = Sizing.bind({});
StaticBlackIndeterminate.tags = ["!dev"];
StaticBlackIndeterminate.storyName = "Static black, indeterminate";
StaticBlackIndeterminate.args = {
staticColor: "black",
isIndeterminate: true,
};
StaticBlackIndeterminate.parameters = {
chromatic: { disableSnapshot: true },
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Variants } from "@spectrum-css/preview/decorators";
import { Template } from "./template.js";

export const InfieldProgressCircleGroup = Variants({
Template,
testData: [
{
testHeading: "Default",
},
{
testHeading: "Static white",
staticColor: "white",
},
{
testHeading: "Static black",
staticColor: "black",
},
],
stateData: [
{
testHeading: "Indeterminate",
isIndeterminate: true,
}
]
});
21 changes: 21 additions & 0 deletions components/infieldprogresscircle/stories/template.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { Template as ProgressCircle } from "@spectrum-css/progresscircle/stories/template.js";
import { capitalize } from "lodash-es";
import "../index.css";

export const Template = ({
customClasses = [],
rootClass = "spectrum-InfieldProgressCircle",
size = "m",
staticColor,
...item
} = {}, context = {}) => ProgressCircle({
customClasses: [
rootClass,
typeof size !== "undefined" ? `${rootClass}--size${size.toUpperCase()}` : null,
typeof staticColor !== "undefined" ? `${rootClass}--static${capitalize(staticColor)}` : null,
...customClasses
].filter(Boolean),
size,
staticColor,
...item
}, context );
6 changes: 3 additions & 3 deletions components/picker/stories/template.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { Template as FieldLabel } from "@spectrum-css/fieldlabel/stories/template.js";
import { Template as HelpText } from "@spectrum-css/helptext/stories/template.js";
import { Template as Icon } from "@spectrum-css/icon/stories/template.js";
import { Template as InfieldProgressCircle } from "@spectrum-css/infieldprogresscircle/stories/template.js";
import { Template as Popover } from "@spectrum-css/popover/stories/template.js";
import { Container, getRandomId } from "@spectrum-css/preview/decorators";
import { Template as ProgressCircle } from "@spectrum-css/progresscircle/stories/template.js";
import { Template as Switch } from "@spectrum-css/switch/stories/template.js";
import { html } from "lit";
import { classMap } from "lit/directives/class-map.js";
Expand Down Expand Up @@ -78,8 +78,8 @@ export const Picker = ({
}
<span class="${rootClass}-label is-placeholder">${placeholder}</span>
${when(isLoading, () =>
ProgressCircle({
size: "s",
InfieldProgressCircle({
size: size,
isIndeterminate: true,
}, context)
)}
Expand Down
Loading
Loading