feat(input-text): add component tokens #12242

anveshmekala · 2025-05-28T23:11:12Z

Related Issue: #7180

Summary

Adds following tokens in input-text component

--calcite-input-action-background-color: Specifies the background color of the component's clearable element.
--calcite-input-action-background-color-hover: Specifies the background color of the component's clearable element when hovered.
--calcite-input-action-background-color-press: Specifies the background color of the component's clearable element when pressed.
--calcite-input-action-icon-color: Specifies the icon color of the component's clearable & icon elements.
--calcite-input-action-icon-color-hover: Specifies the icon color of the component's clearable & icon elements when hovered.
--calcite-input-action-icon-color-press: Specifies the icon color of the component's clearable & icon elements when pressed.
--calcite-input-loading-background-color: Specifies the background color of the loading element.
--calcite-input-loading-fill-color: Specifies the fill color of the loading element.
--calcite-input-prefix-background-color: When prefixText is provided, specifies the background color of the component's prefix element.
--calcite-input-prefix-size-x: When prefixText is provided, specifies the width of the component's prefix element.
--calcite-input-prefix-text-color: When prefixText is provided, specifies the text color of the component's prefix element.
--calcite-input-suffix-background-color: When suffixText is provided, specifies the background color of the component's suffix element.
--calcite-input-suffix-size-x: When suffixText is provided, specifies the width of the component's suffix element.
--calcite-input-suffix-text-color: When suffixText is provided, specifies the color of the component's suffix element.
--calcite-input-text-background-color: Specifies the component's background color.
--calcite-input-text-border-color: Specifies the component's border color.
--calcite-input-text-corner-radius: Specifies the component's border radius.
--calcite-input-text-icon-color: Specifies the component's icon color.
--calcite-input-text-placeholder-text-color: Specifies the component's placeholder text color.
--calcite-input-text-text-color: Specifies the component's text color.
--calcite-input-text-text-color-focus: Specifies the component's text color when focused.

packages/calcite-components/src/components/input-text/input-text.scss

driskull

The changes look good. My comments are mostly regarding naming consistency and the height var.

driskull · 2025-06-02T20:44:05Z

packages/calcite-components/src/components/input-text/input-text.scss

@@ -3,8 +3,27 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
- * @prop --calcite-input-prefix-size: Specifies the component's prefix width.
- * @prop --calcite-input-suffix-size: Specifies the component's suffix width.
+ * @prop --calcite-input-actions-background-color: Specifies the background color of the component's `clearable` element.


Not really related but should --calcite-input-actions be --calcite-input-action? I'm not sure why actions is plural here since we're referencing a component. I don't think we do -icons- in other places where more than one icon is present.

Good Point. This is chosen to match existing naming patterns. Both input & input-number uses this pattern for tokens. Though input, input-number have multiple action elements, input-text has only one.

--calcite-input-action makes sense here. Should this be changed in other places too?

Should this be changed in other places too?

It would be nice but it would mean deprecating and then removing later if they have already been released. I'd like to hear from @jcfranco on if we should rename them. We may need to update our guidelines to not have tokens representing other components to be plural.

Agreed on avoiding plurals in naming when possible. A nice side benefit is that it avoids having to rename if the prop target shifts between one and many.

In terms of this PR, input-text can use the revised slot names. We can deprecate the existing ones in a follow-up PR aimed at 25.R3, which will be removed in 4.0 (26.R1). cc @geospatialem @DitwanP @isaacbraun

Worth noting that autocomplete and filter also use similarly named props.

We may need to update our guidelines to not have tokens representing other components to be plural.

Good idea. We may be able to prevent this via linting too, but we'll need to do some investigation.

In terms of this PR, input-text can use the revised slot names. We can deprecate the existing ones in a follow-up PR aimed at 25.R3, which will be removed in 4.0 (26.R1). cc @geospatialem @DitwanP @isaacbraun

Created #12356 for tracking

driskull · 2025-06-02T20:45:08Z

packages/calcite-components/src/components/input-text/input-text.scss

+ * @prop --calcite-input-prefix-size: Specifies the width of the prefix element.
+ * @prop --calcite-input-prefix-text-color: Specifies the text color of the prefix element.
+ * @prop --calcite-input-suffix-background-color: Specifies the background color of the suffix element.
+ * @prop --calcite-input-suffix-size: Specifies the width of the suffix element.


I think we've had other discussion on what to name size vars. Should this be width or size-x? If its just size its not apparent it is for the width.

@driskull As discussed, this should be size-x i believe.

Added #12394

driskull · 2025-06-02T20:46:42Z

packages/calcite-components/src/components/input-text/input-text.scss

@@ -21,7 +40,8 @@
  & input,
  & .prefix,
  & .suffix {
-    @apply text-n2h h-6;
+    @apply text-n2h;
+    block-size: var(--calcite-input-text-height, 1.5rem);


Why do we need to set the height? Shouldn't just font-size and line-height be enough?

It is enough to set the height but i believe the desired height is different from what font-size & line-height.

Adding @macandcheese for more thoughts.

github-actions · 2025-06-13T02:10:41Z

This PR has been automatically marked as stale because it has not had recent activity. Please close your PR if it is no longer relevant. Thank you for your contributions.

driskull

LGTM!

geospatialem

Awesome @anveshmekal! ✨💪🏻✨ Have a few doc consistency suggestions for consideration below. 📚

geospatialem · 2025-06-21T17:01:43Z

packages/calcite-components/src/components/input-text/input-text.scss

+ * @prop --calcite-input-action-background-color: Specifies the background color of the component's `clearable` element.
+ * @prop --calcite-input-action-background-color-hover: Specifies the background color of the component's `clearable` element when hovered.
+ * @prop --calcite-input-action-background-color-press: Specifies the background color of the component's `clearable` element when pressed.
+ * @prop --calcite-input-action-icon-color: Specifies the icon color of the component's `clearable` & icon elements.
+ * @prop --calcite-input-action-icon-color-hover: Specifies the icon color of the component's `clearable` & icon elements when hovered.
+ * @prop --calcite-input-action-icon-color-press: Specifies the icon color of the component's `clearable` & icon elements when pressed.
+ * @prop --calcite-input-loading-background-color: Specifies the background color of the `loading` element.
+ * @prop --calcite-input-loading-fill-color: Specifies the fill color of the `loading` element.
+ * @prop --calcite-input-prefix-background-color: Specifies the background color of the prefix element.
+ * @prop --calcite-input-prefix-width: Specifies the width of the prefix element.
+ * @prop --calcite-input-prefix-text-color: Specifies the text color of the prefix element.
+ * @prop --calcite-input-suffix-background-color: Specifies the background color of the suffix element.
+ * @prop --calcite-input-suffix-width: Specifies the width of the suffix element.
+ * @prop --calcite-input-suffix-text-color: Specifies the text color of the suffix element.
+ * @prop --calcite-input-text-background-color: Specifies background color of the component.
+ * @prop --calcite-input-text-border-color: Specifies the border color of the component.
+ * @prop --calcite-input-text-corner-radius: Specifies the border radius of the component.
+ * @prop --calcite-input-text-placeholder-text-color: Specifies the text color of the placeholder in the component.
+ * @prop --calcite-input-text-text-color: Specifies the text color of the component.
+ * @prop --calcite-input-text-text-color-focus: Specifies the text color of the component when focused.


Few doc consistency suggestions:

Suggested change

* @prop --calcite-input-action-background-color: Specifies the background color of the component's `clearable` element.

* @prop --calcite-input-action-background-color-hover: Specifies the background color of the component's `clearable` element when hovered.

* @prop --calcite-input-action-background-color-press: Specifies the background color of the component's `clearable` element when pressed.

* @prop --calcite-input-action-icon-color: Specifies the icon color of the component's `clearable` & icon elements.

* @prop --calcite-input-action-icon-color-hover: Specifies the icon color of the component's `clearable` & icon elements when hovered.

* @prop --calcite-input-action-icon-color-press: Specifies the icon color of the component's `clearable` & icon elements when pressed.

* @prop --calcite-input-loading-background-color: Specifies the background color of the `loading` element.

* @prop --calcite-input-loading-fill-color: Specifies the fill color of the `loading` element.

* @prop --calcite-input-prefix-background-color: Specifies the background color of the prefix element.

* @prop --calcite-input-prefix-width: Specifies the width of the prefix element.

* @prop --calcite-input-prefix-text-color: Specifies the text color of the prefix element.

* @prop --calcite-input-suffix-background-color: Specifies the background color of the suffix element.

* @prop --calcite-input-suffix-width: Specifies the width of the suffix element.

* @prop --calcite-input-suffix-text-color: Specifies the text color of the suffix element.

* @prop --calcite-input-text-background-color: Specifies background color of the component.

* @prop --calcite-input-text-border-color: Specifies the border color of the component.

* @prop --calcite-input-text-corner-radius: Specifies the border radius of the component.

* @prop --calcite-input-text-placeholder-text-color: Specifies the text color of the placeholder in the component.

* @prop --calcite-input-text-text-color: Specifies the text color of the component.

* @prop --calcite-input-text-text-color-focus: Specifies the text color of the component when focused.

* @prop --calcite-input-action-background-color: Specifies the background color of the component's `clearable` element.

* @prop --calcite-input-action-background-color-hover: Specifies the background color of the component's `clearable` element when hovered.

* @prop --calcite-input-action-background-color-press: Specifies the background color of the component's `clearable` element when pressed.

* @prop --calcite-input-action-icon-color: Specifies the icon color of the component's `clearable` & icon elements.

* @prop --calcite-input-action-icon-color-hover: Specifies the icon color of the component's `clearable` & icon elements when hovered.

* @prop --calcite-input-action-icon-color-press: Specifies the icon color of the component's `clearable` & icon elements when pressed.

* @prop --calcite-input-loading-background-color: Specifies the background color of the `loading` element.

* @prop --calcite-input-loading-fill-color: Specifies the fill color of the `loading` element.

* @prop --calcite-input-prefix-background-color: When `prefixText` is provided, specifies the background color of the component's prefix element.

* @prop --calcite-input-prefix-width: When `prefixText` is provided, specifies the width of the component's prefix element.

* @prop --calcite-input-prefix-text-color: When `prefixText` is provided, specifies the text color of the component's prefix element.

* @prop --calcite-input-suffix-background-color: When `suffixText` is provided, specifies the background color of the component's suffix element.

* @prop --calcite-input-suffix-width: When suffixText` is provided, specifies the width of the component's suffix element.

* @prop --calcite-input-suffix-text-color: When `suffixText` is provided, specifies the color of the component's suffix element.

* @prop --calcite-input-text-background-color: Specifies the component's background color.

* @prop --calcite-input-text-border-color: Specifies the component's border color.

* @prop --calcite-input-text-corner-radius: Specifies the component's border radius.

* @prop --calcite-input-text-placeholder-text-color: Specifies the component's `placeholder` text color.

* @prop --calcite-input-text-text-color: Specifies the component's text color.

* @prop --calcite-input-text-text-color-focus: Specifies the component's text color when focused.

driskull · 2025-06-25T21:25:32Z

👍

matgalla · 2025-06-26T16:22:18Z

Thinking about --calcite-input-action-icon-color -

Currently, Action's --calcite-action-text-color changes both the text and the icon. If we want to support a new Action token, --calcite-action-icon-color then that would line up with this Input Text token.
That said, even if we don't make any changes to Action tokens, I still think the name you have now is better than using -text from Action. Just wanted to mention this in case we want to add a new token to Action to match.

ashetland · 2025-06-26T16:27:05Z

packages/calcite-components/src/components/input-text/input-text.scss

@@ -3,8 +3,26 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
- * @prop --calcite-input-prefix-size: Specifies the component's prefix width.
- * @prop --calcite-input-suffix-size: Specifies the component's suffix width.
+ * @prop --calcite-input-action-background-color: Specifies the background color of the component's `clearable` element.


Should these all be labeled --calcite-input-text-action...?

Just realized that only these use the full "input-text". Is that intentional?

--calcite-input-text-background-color --calcite-input-text-border-color --calcite-input-text-corner-radius --calcite-input-text-placeholder-text-color --calcite-input-text-text-color --calcite-input-text-text-color-focus

Since input components share the same design pattern, we were using generic token names such as --calcite-input-action-background-color instead of --calcite-input-text-action-background-color.

Similar to whats discussed here #10206 (comment)

macandcheese

Awesome!

anveshmekala · 2025-06-26T18:00:14Z

Thinking about --calcite-input-action-icon-color -

Currently, Action's --calcite-action-text-color changes both the text and the icon. If we want to support a new Action token, --calcite-action-icon-color then that would line up with this Input Text token.
That said, even if we don't make any changes to Action tokens, I still think the name you have now is better than using -text from Action. Just wanted to mention this in case we want to add a new token to Action to match.

Good Point. This made me relook and figured I missed the token for icon in input-text here .

Must have slipped through in input-number too.

ashetland · 2025-06-26T18:27:11Z

packages/calcite-components/src/components/input-text/input-text.scss

@@ -20,6 +20,7 @@
 * @prop --calcite-input-text-background-color: Specifies the component's background color.
 * @prop --calcite-input-text-border-color: Specifies the component's border color.
 * @prop --calcite-input-text-corner-radius: Specifies the component's border radius.
+ * @prop --calcite-input-text-icon-color: Specifies the component's icon color.


I think we're missing this on Input Number.

Ha! You caught that too.

feat(input-text): add component tokens

af6650c

github-actions bot assigned anveshmekala May 28, 2025

github-actions bot added the enhancement Issues tied to a new feature or request. label May 28, 2025

anveshmekala added 5 commits May 28, 2025 22:21

prettify jsdoc

a5929b1

add tests

a6d4dc3

Add stories & demo

8a24f32

fix test failures

741867e

cleanup

f4a7ffd

anveshmekala marked this pull request as ready for review May 30, 2025 20:13

anveshmekala added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label May 30, 2025

fix storybook build

7ae8513

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 30, 2025

macandcheese reviewed Jun 2, 2025

View reviewed changes

packages/calcite-components/src/components/input-text/input-text.scss Outdated Show resolved Hide resolved

driskull reviewed Jun 2, 2025

View reviewed changes

github-actions bot added the Stale Issues or pull requests that have not had recent activity. label Jun 13, 2025

anveshmekala removed the Stale Issues or pull requests that have not had recent activity. label Jun 13, 2025

This was referenced Jun 18, 2025

[Refactor] Component tokens naming conventions to singular, deprecates plural naming conventions #12356

Open

[Refactor] Remove deprecated plural-named component tokens #12365

Open

anveshmekala added 3 commits June 20, 2025 12:56

Merge branch 'dev' into anveshmekala/7180-input-text-tokens

8fc900a

rename action tokens & remove height token

d7301f5

rename size to width

7cd9fb9

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 20, 2025

anveshmekala requested review from macandcheese and driskull June 20, 2025 21:45

driskull approved these changes Jun 20, 2025

View reviewed changes

geospatialem reviewed Jun 21, 2025

View reviewed changes

doc changes

18aeba0

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 23, 2025

anveshmekala and others added 2 commits June 23, 2025 09:38

cleanup

812ec14

Merge branch 'dev' into anveshmekala/7180-input-text-tokens

4495b78

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 23, 2025

revert suffix & prefix token

74e92e9

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 23, 2025

rename width to size-x

9f25970

anveshmekala mentioned this pull request Jun 25, 2025

Use size naming convention with direction variant for width & height tokens. #12394

Open

10 tasks

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 25, 2025

anveshmekala requested a review from ashetland June 25, 2025 22:27

ashetland reviewed Jun 26, 2025

View reviewed changes

macandcheese approved these changes Jun 26, 2025

View reviewed changes

fix icon prop token

3b164e6

ashetland reviewed Jun 26, 2025

View reviewed changes

anveshmekala added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Jun 26, 2025

anveshmekala merged commit b156f4e into dev Jun 26, 2025
14 checks passed

anveshmekala deleted the anveshmekala/7180-input-text-tokens branch June 26, 2025 19:47

github-actions bot added this to the 2025-07-29 - Jul Milestone milestone Jun 26, 2025

feat(input-text): add component tokens #12242

feat(input-text): add component tokens #12242

Uh oh!

Conversation

anveshmekala commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Uh oh!

driskull left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anveshmekala Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 13, 2025

Uh oh!

driskull left a comment

Choose a reason for hiding this comment

Uh oh!

geospatialem left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

driskull commented Jun 25, 2025

Uh oh!

matgalla commented Jun 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashetland Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anveshmekala Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

macandcheese left a comment

Choose a reason for hiding this comment

Uh oh!

anveshmekala commented Jun 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

anveshmekala commented May 28, 2025 •

edited

Loading

anveshmekala Jun 2, 2025 •

edited

Loading

ashetland Jun 26, 2025 •

edited

Loading

anveshmekala Jun 26, 2025 •

edited

Loading