Skip to content

Commit e92cd9a

Browse files
git-nandorclaude
andcommitted
docs(many): migrate v2 component examples to the new spacing scale
Replace the deprecated canvas spacing keywords (small, medium, large, x-small, x-large, xx-large) with general.* Spacing tokens, and the deprecated icon size keyword (medium) with the semantic "md", across the v2 component README examples so the published docs stop teaching deprecated values. INSTUI-5118 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 49b97ec commit e92cd9a

38 files changed

Lines changed: 248 additions & 248 deletions

File tree

packages/ui-alerts/src/Alert/v2/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,11 +187,11 @@ When Alerts are used inline, the shadow can be removed with the `hasShadow` prop
187187
---
188188
type: example
189189
---
190-
<View as="div" background="primary" padding="large">
190+
<View as="div" background="primary" padding="general.space2xl">
191191
<View
192192
as="div"
193193
background="primary"
194-
padding="small medium"
194+
padding="general.spaceMd general.spaceXl"
195195
borderWidth="small"
196196
borderRadius="small"
197197
margin="general.spaceSm 0"
@@ -209,7 +209,7 @@ type: example
209209
<View
210210
as="div"
211211
background="primary"
212-
padding="small medium"
212+
padding="general.spaceMd general.spaceXl"
213213
borderWidth="small"
214214
borderRadius="small"
215215
margin="general.spaceSm 0"

packages/ui-avatar/src/Avatar/v2/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ readonly: true
1515
---
1616

1717
<div>
18-
<View display="block" padding="small medium" background="primary">
18+
<View display="block" padding="general.spaceMd general.spaceXl" background="primary">
1919
<Avatar name="Arthur C. Clarke" />
2020
<Avatar name="James Arias" color="accent2" />
2121
<Avatar name="Charles Kimball" color="accent3" />
@@ -24,7 +24,7 @@ readonly: true
2424
<Avatar name="David Herbert" color="accent6" />
2525
<Avatar name="Isaac Asimov" color="accent1" />
2626
</View>
27-
<View display="block" padding="small medium" background="primary">
27+
<View display="block" padding="general.spaceMd general.spaceXl" background="primary">
2828
<Avatar name="Arthur C. Clarke" hasInverseColor />
2929
<Avatar name="James Arias" color="accent2" hasInverseColor />
3030
<Avatar name="Charles Kimball" color="accent3" hasInverseColor />
@@ -45,7 +45,7 @@ There is a need for special, `ai avatars`. These have a specific look. You can a
4545
type: example
4646
readonly: true
4747
---
48-
<View display="block" padding="small medium" background="primary">
48+
<View display="block" padding="general.spaceMd general.spaceXl" background="primary">
4949
<Avatar size="xx-small" color="ai" name="AI Assistant" renderIcon={IgniteaiLogoInstUIIcon} />
5050
<Avatar size="x-small" color="ai" name="AI Assistant" renderIcon={IgniteaiLogoInstUIIcon} />
5151
<Avatar size="small" color="ai" name="AI Assistant" renderIcon={IgniteaiLogoInstUIIcon} />
@@ -65,7 +65,7 @@ Lucide icons in Avatar are automatically sized and colored according to the Avat
6565
type: example
6666
---
6767
<div>
68-
<View display="block" padding="small medium">
68+
<View display="block" padding="general.spaceMd general.spaceXl">
6969
<Avatar name="User Avatar" size="xx-small" renderIcon={UserInstUIIcon} />
7070
<Avatar name="User Avatar" size="x-small" renderIcon={UserInstUIIcon} />
7171
<Avatar name="User Avatar" size="small" renderIcon={UserInstUIIcon} />
@@ -74,12 +74,12 @@ type: example
7474
<Avatar name="User Avatar" size="x-large" renderIcon={UserInstUIIcon} />
7575
<Avatar name="User Avatar" size="xx-large" renderIcon={UserInstUIIcon} />
7676
</View>
77-
<View display="block" padding="small medium">
77+
<View display="block" padding="general.spaceMd general.spaceXl">
7878
<Avatar name="Profile" size="small" color="accent2" renderIcon={<CircleUserInstUIIcon />} />
7979
<Avatar name="Group" size="medium" color="accent3" renderIcon={<UsersInstUIIcon />} />
8080
<Avatar name="Settings" size="large" color="accent4" renderIcon={<SettingsInstUIIcon />} />
8181
</View>
82-
<View display="block" padding="small medium">
82+
<View display="block" padding="general.spaceMd general.spaceXl">
8383
<Avatar name="Profile" size="large" color="accent4" renderIcon={()=><CircleUserInstUIIcon />} />
8484
<Avatar name="Group" size="x-large" color="accent5" renderIcon={()=><UsersInstUIIcon />} />
8585
<Avatar name="Settings" size="xx-large" color="accent6" renderIcon={()=><SettingsInstUIIcon />} />
@@ -96,7 +96,7 @@ The `size` prop allows you to select from `xx-small`, `x-small`, `small`, `mediu
9696
type: example
9797
---
9898
<div>
99-
<View display="block" padding="small medium">
99+
<View display="block" padding="general.spaceMd general.spaceXl">
100100
<Avatar name="Arthur C. Clarke" size="xx-small" />
101101
<Avatar name="James Arias" size="x-small" />
102102
<Avatar name="Charles Kimball" size="small" />
@@ -105,7 +105,7 @@ type: example
105105
<Avatar name="David Herbert" size="x-large" />
106106
<Avatar name="Isaac Asimov" size="xx-large" />
107107
</View>
108-
<View display="block" padding="small medium" background="primary">
108+
<View display="block" padding="general.spaceMd general.spaceXl" background="primary">
109109
<Avatar name="Arthur C. Clarke" size="xx-small" src={avatarSquare} />
110110
<Avatar name="James Arias" size="x-small" src={avatarSquare} />
111111
<Avatar name="Charles Kimball" size="small" src={avatarSquare} />
@@ -114,7 +114,7 @@ type: example
114114
<Avatar name="David Herbert" size="x-large" src={avatarSquare} />
115115
<Avatar name="Isaac Asimov" size="xx-large" src={avatarSquare} />
116116
</View>
117-
<View display="block" padding="small medium">
117+
<View display="block" padding="general.spaceMd general.spaceXl">
118118
<Avatar name="Arthur C. Clarke" renderIcon={UsersInstUIIcon} size="xx-small" />
119119
<Avatar name="James Arias" renderIcon={UsersInstUIIcon} size="x-small" />
120120
<Avatar name="Charles Kimball" renderIcon={UsersInstUIIcon} size="small" />
@@ -135,7 +135,7 @@ The color of the initials and icons can be set with the `color` prop, and it all
135135
type: example
136136
---
137137
<div>
138-
<View display="block" padding="small medium">
138+
<View display="block" padding="general.spaceMd general.spaceXl">
139139
<Avatar name="Arthur C. Clarke" />
140140
<Avatar name="James Arias" color="accent2" />
141141
<Avatar name="Charles Kimball" color="accent3" />
@@ -144,7 +144,7 @@ type: example
144144
<Avatar name="David Herbert" color="accent6" />
145145
<Avatar name="Isaac Asimov" color="accent1" />
146146
</View>
147-
<View display="block" padding="small medium">
147+
<View display="block" padding="general.spaceMd general.spaceXl">
148148
<Avatar renderIcon={UsersInstUIIcon} name="Arthur C. Clarke" />
149149
<Avatar renderIcon={UsersInstUIIcon} name="James Arias" color="accent2" />
150150
<Avatar renderIcon={UsersInstUIIcon} name="Charles Kimball" color="accent3" />
@@ -165,7 +165,7 @@ Inverted Avatars have **no border**.
165165
type: example
166166
---
167167
<div>
168-
<View display="block" padding="small medium" background="primary">
168+
<View display="block" padding="general.spaceMd general.spaceXl" background="primary">
169169
<Avatar name="Arthur C. Clarke" hasInverseColor />
170170
<Avatar name="James Arias" color="accent2" hasInverseColor />
171171
<Avatar name="Charles Kimball" color="accent3" hasInverseColor />
@@ -174,7 +174,7 @@ type: example
174174
<Avatar name="David Herbert" color="accent6" hasInverseColor />
175175
<Avatar name="Isaac Asimov" color="accent1" hasInverseColor />
176176
</View>
177-
<View display="block" padding="small medium" background="primary">
177+
<View display="block" padding="general.spaceMd general.spaceXl" background="primary">
178178
<Avatar renderIcon={UsersInstUIIcon} name="Arthur C. Clarke" hasInverseColor />
179179
<Avatar renderIcon={UsersInstUIIcon} name="James Arias" color="accent2" hasInverseColor />
180180
<Avatar renderIcon={UsersInstUIIcon} name="Charles Kimball" color="accent3" hasInverseColor />

packages/ui-badge/src/Badge/v2/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Setting `type="notification"` will render small circles that should not contain
7979
type: example
8080
---
8181
<div>
82-
<Flex padding='small' display='inline-flex' alignItems="center">
82+
<Flex padding='general.spaceMd' display='inline-flex' alignItems="center">
8383
<Badge standalone count={6} margin='0 general.spaceMd 0 0' />
8484
<Badge
8585
type="notification"
@@ -89,7 +89,7 @@ type: example
8989
}}
9090
/>
9191
</Flex>
92-
<Flex padding='small' display='inline-flex' alignItems="center">
92+
<Flex padding='general.spaceMd' display='inline-flex' alignItems="center">
9393
<Badge standalone variant="success" count={12} margin='0 general.spaceMd 0 0' />
9494
<Badge
9595
variant="success"
@@ -100,7 +100,7 @@ type: example
100100
}}
101101
/>
102102
</Flex>
103-
<Flex padding='small' display='inline-flex' alignItems="center">
103+
<Flex padding='general.spaceMd' display='inline-flex' alignItems="center">
104104
<Badge standalone variant="danger" count={18} countUntil={10} margin='0 general.spaceMd 0 0' />
105105
<Badge
106106
variant="danger"
@@ -112,7 +112,7 @@ type: example
112112
/>
113113
</Flex>
114114
<View display='inline-flex' background='primary-inverse'>
115-
<Flex padding='small' display='inline-flex' alignItems="center" background='primary-inverse'>
115+
<Flex padding='general.spaceMd' display='inline-flex' alignItems="center" background='primary-inverse'>
116116
<Badge standalone variant="inverse" count={8} margin='0 general.spaceMd 0 0' />
117117
<Badge
118118
variant="inverse"

packages/ui-breadcrumb/src/Breadcrumb/v2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ type: example
3535
<Link
3636
href="#"
3737
variant="standalone"
38-
renderIcon={IconArrowOpenStartLine}
38+
renderIcon={ChevronLeftInstUIIcon}
3939
>
4040
<TruncateText>University of Utah Colleges</TruncateText>
4141
</Link>

packages/ui-buttons/src/Button/v2/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The `primary-inverse` color is designed for use on colored backgrounds. It provi
3737
---
3838
type: example
3939
---
40-
<View display="block" background="info" padding="small">
40+
<View display="block" background="info" padding="general.spaceMd">
4141
<Button color="primary-inverse" margin="general.spaceMd">Primary Inverse</Button>
4242
</View>
4343
```
@@ -110,7 +110,7 @@ type: example
110110
display="block"
111111
width="10rem"
112112
margin="general.spaceMd"
113-
padding="small none"
113+
padding="general.spaceMd none"
114114
withVisualDebug
115115
>
116116
<Button color="primary">
@@ -147,7 +147,7 @@ type: example
147147
display="block"
148148
width="10rem"
149149
margin="general.spaceMd"
150-
padding="small none"
150+
padding="general.spaceMd none"
151151
withVisualDebug
152152
>
153153
{isTruncated ? (
@@ -179,7 +179,7 @@ type: example
179179
display="block"
180180
width="30rem"
181181
margin="general.spaceMd"
182-
padding="small none"
182+
padding="general.spaceMd none"
183183
withVisualDebug
184184
>
185185
<Button
@@ -273,7 +273,7 @@ type: example
273273
<RadioInput label="secondary" value="secondary" />
274274
</RadioInputGroup>
275275
</View>
276-
<Flex margin="none none general.spaceXl" gap="medium">
276+
<Flex margin="none none general.spaceXl" gap="general.spaceXl">
277277
<Flex.Item>
278278
<Button withBackground={this.state.withBackground}
279279
color={this.state.color}

packages/ui-buttons/src/CloseButton/v2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ If you need the `CloseButton` to work in a layout with other elements vs. absolu
2222
type: example
2323
---
2424
<View display="block" position="relative" background="primary" shadow="resting">
25-
<Flex height="6rem" justifyItems="space-between" alignItems="center" padding="medium">
25+
<Flex height="6rem" justifyItems="space-between" alignItems="center" padding="general.spaceXl">
2626
<Flex.Item shouldShrink shouldGrow>
2727
<Heading level="h2">Some Heading Text</Heading>
2828
</Flex.Item>
29-
<Flex.Item padding="none none none medium">
29+
<Flex.Item padding="none none none general.spaceXl">
3030
<CloseButton size="medium" screenReaderLabel="Close" />
3131
</Flex.Item>
3232
</Flex>

packages/ui-buttons/src/CondensedButton/v2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ CondensedButton is a button component that renders without padding. It is meant
88
---
99
type: example
1010
---
11-
<View display="block" background="primary" padding="small">
11+
<View display="block" background="primary" padding="general.spaceMd">
1212
<CondensedButton>Click Me</CondensedButton>
1313
</View>
1414
```

packages/ui-buttons/src/ToggleButton/v2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type: example
1717
}
1818

1919
return (
20-
<View as="div" padding="x-large" id="toggleContainer">
20+
<View as="div" padding="general.space2xl" id="toggleContainer">
2121
<ToggleButton
2222
status={locked ? 'pressed' : 'unpressed'}
2323
color={locked ? 'danger' : 'secondary'}
@@ -49,7 +49,7 @@ type: example
4949
return (
5050
<View
5151
as="div"
52-
padding="xx-large"
52+
padding="general.space2xl"
5353
background="info"
5454
id="inverseToggleContainer"
5555
>

packages/ui-byline/src/Byline/v2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ type: example
5454
</Text>
5555
</View>
5656
}>
57-
<HeartInstUIIcon size="medium" color="successColor" />
57+
<HeartInstUIIcon size="md" color="successColor" />
5858
</Byline>
5959
```

packages/ui-checkbox/src/Checkbox/v2/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ type: example
7575
checked={value.length === 3}
7676
indeterminate={value.length > 0 && value.length < 3}
7777
/>
78-
<View as="div" padding="0 0 0 medium">
78+
<View as="div" padding="0 0 0 general.spaceXl">
7979
<Checkbox
8080
aria-labelledby="groupLabel eng203Label"
8181
label={<span id="eng203Label">English 203</span>}
@@ -87,7 +87,7 @@ type: example
8787
checked={value.indexOf('eng203') !== -1}
8888
/>
8989
</View>
90-
<View as="div" padding="0 0 0 medium">
90+
<View as="div" padding="0 0 0 general.spaceXl">
9191
<Checkbox
9292
aria-labelledby="groupLabel sci101Label"
9393
label={<span id="sci101Label">Science 101</span>}
@@ -99,7 +99,7 @@ type: example
9999
checked={value.indexOf('sci101') !== -1}
100100
/>
101101
</View>
102-
<View as="div" padding="0 0 0 medium">
102+
<View as="div" padding="0 0 0 general.spaceXl">
103103
<Checkbox
104104
aria-labelledby="groupLabel hist101Label"
105105
label={<span id="hist101Label">History 111</span>}

0 commit comments

Comments
 (0)