Skip to content

Commit 2870bc9

Browse files
docs(button): remove MDX file
- delete mdx file in favor of all docs being in stories file - update some story names to follow sentence-casing and organize like- stories together * docs(icon): remove MDX file - delete mdx file in favor of all docs being in stories file - update some story names to follow sentence-casing and organize like- stories together - move some markup into template file instead of stories file * docs(typography): add docs for rtl notes
1 parent 3dcc4ef commit 2870bc9

File tree

6 files changed

+124
-311
lines changed

6 files changed

+124
-311
lines changed

components/button/stories/button.mdx

-119
This file was deleted.

components/button/stories/button.stories.js

+18-3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ import { ButtonsWithIconOptions, TextOverflowTemplate, TextWrapTemplate, Treatme
99

1010
/**
1111
* Buttons allow users to perform an action or to navigate to another page. They have multiple styles for various needs, and are ideal for calling attention to where a user needs to do something in order to move forward in a flow.
12+
*
13+
* There are four available variants that are used for different levels of emphasis and different
14+
* types of actions. By default, a button uses the fill style with a solid background. The primary
15+
* and secondary variants also have an outline option.
1216
*/
1317
export default {
1418
title: "Button",
@@ -92,11 +96,11 @@ export default {
9296
packageJson,
9397
metadata,
9498
},
95-
tags: ["!autodocs"],
9699
};
97100

98101
export const Default = ButtonGroups.bind({});
99102
Default.args = {};
103+
Default.tags = ["!autodocs"];
100104

101105
// ********* VRT ONLY ********* //
102106
export const WithForcedColors = ButtonGroups.bind({});
@@ -188,6 +192,9 @@ Negative.parameters = {
188192
chromatic: { disableSnapshot: true },
189193
};
190194

195+
/**
196+
* When a button needs to be placed on top of a dark color background or a visual, use the static white options. Static color buttons do not change shades or values depending upon the color theme.
197+
*/
191198
export const StaticWhitePrimary = TreatmentTemplate.bind({});
192199
StaticWhitePrimary.tags = ["!dev"];
193200
StaticWhitePrimary.args = {
@@ -198,6 +205,7 @@ StaticWhitePrimary.args = {
198205
StaticWhitePrimary.parameters = {
199206
chromatic: { disableSnapshot: true },
200207
};
208+
StaticWhitePrimary.storyName = "Static white - primary";
201209

202210
export const StaticWhiteSecondary = TreatmentTemplate.bind({});
203211
StaticWhiteSecondary.tags = ["!dev"];
@@ -209,7 +217,11 @@ StaticWhiteSecondary.args = {
209217
StaticWhiteSecondary.parameters = {
210218
chromatic: { disableSnapshot: true },
211219
};
220+
StaticWhiteSecondary.storyName = "Static white - secondary";
212221

222+
/**
223+
* When a button needs to be placed on top of a light color background or a visual, use the static black options. Static color buttons do not change shades or values depending upon the color theme.
224+
*/
213225
export const StaticBlackPrimary = TreatmentTemplate.bind({});
214226
StaticBlackPrimary.tags = ["!dev"];
215227
StaticBlackPrimary.args = {
@@ -220,6 +232,7 @@ StaticBlackPrimary.args = {
220232
StaticBlackPrimary.parameters = {
221233
chromatic: { disableSnapshot: true },
222234
};
235+
StaticBlackPrimary.storyName = "Static black - primary";
223236

224237
export const StaticBlackSecondary = TreatmentTemplate.bind({});
225238
StaticBlackSecondary.tags = ["!dev"];
@@ -231,6 +244,8 @@ StaticBlackSecondary.args = {
231244
StaticBlackSecondary.parameters = {
232245
chromatic: { disableSnapshot: true },
233246
};
247+
StaticBlackSecondary.storyName = "Static black - secondary";
248+
234249

235250
/**
236251
* The pending button is for indicating that a quick progress action is taking place. In this case, the
@@ -273,7 +288,7 @@ Disabled.parameters = {
273288
*/
274289
export const WithWrapping = TextOverflowTemplate.bind({});
275290
WithWrapping.tags = ["!dev"];
276-
WithWrapping.storyName = "Text overflow behavior";
291+
WithWrapping.storyName = "Text overflow";
277292
WithWrapping.args = {
278293
variant: "primary",
279294
};
@@ -289,7 +304,7 @@ WithWrapping.parameters = {
289304

290305
export const DisableWrapping = TextWrapTemplate.bind({});
291306
DisableWrapping.tags = ["!dev"];
292-
DisableWrapping.storyName = "Disable label wrap";
307+
DisableWrapping.storyName = "Text overflow - disabled text wrap";
293308
DisableWrapping.args = {
294309
variant: "primary",
295310
};

components/icon/stories/icon.mdx

-84
This file was deleted.

0 commit comments

Comments
 (0)