Skip to content

Commit

Permalink
docs: consistency improvements between docs
Browse files Browse the repository at this point in the history
  • Loading branch information
booc0mtaco committed Nov 8, 2023
1 parent c98c9e5 commit 174aef4
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 17 deletions.
4 changes: 2 additions & 2 deletions src/components/Accordion/Accordion.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ type AccordionProps = {
/**
* Outline variant adds adjusts the `Accordion` style by defining a containing border and other layout adjustments.
*
* **Default is `false`.**
* **Default is `false`**.
*/
hasOutline?: boolean;
/**
Expand Down Expand Up @@ -49,7 +49,7 @@ type AccordionButtonProps = {
/**
* Icon override for component.
*
* **Default is `expand-more`**.
* **Default is `"expand-more"`**.
*/
icon?: Extract<IconName, 'expand-more'>;
/**
Expand Down
4 changes: 2 additions & 2 deletions src/components/Card/Card.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const Horizontal: StoryObj<Args> = {
};

/**
* Shows `Card` with `elevation` set to `'raised'`
* Shows `Card` with `elevation` set to `"raised"`
*/
export const Raised: StoryObj<Args> = {
args: {
Expand All @@ -67,7 +67,7 @@ export const Raised: StoryObj<Args> = {
};

/**
* Shows `Card` with `elevation` set to `'dragging'`
* Shows `Card` with `elevation` set to `"dragging"`
*/
export const Dragging: StoryObj<Args> = {
args: {
Expand Down
6 changes: 3 additions & 3 deletions src/components/Card/Card.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ export interface CardProps extends HTMLAttributes<HTMLElement> {
* - **raised** renders the card that is raised off of the canvas (box-shadow applied)
* - **dragging** renders the card that is raised even further off the canvas (during drag)
*
* **Default is `'none'`.**
* **Default is `'none'`**.
*/
elevation?: 'none' | 'raised' | 'dragging';
/**
* Property to apply a "dragging" elevation. Can be use while card is in a moving state.
*
* **Default is `'false'`.**
* **Default is `false`**.
*/
isDragging?: boolean;
/**
Expand All @@ -33,7 +33,7 @@ export interface CardProps extends HTMLAttributes<HTMLElement> {
* - **horizontal** renders the header, body, and footer in a horizontal fashion
* where the body is required but the header and footer are not
*
* **Default is `'vertical'`.**
* **Default is `"vertical"`**.
* @deprecated
*/
orientation?: 'vertical' | 'horizontal';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Checkbox/Checkbox.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ type CheckboxProps = Omit<CheckboxInputProps, 'id'> & {
/**
* Size of the checkbox and associated label.
*
* **Defaults to 'lg'.**
* **Default is `"lg"`**.
*/
size?: Extract<Size, 'md' | 'lg'>;
} & EitherInclusive<
Expand Down
2 changes: 1 addition & 1 deletion src/components/InputField/InputField.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export type InputFieldProps = React.InputHTMLAttributes<HTMLInputElement> & {
/**
* Error variant of the form field
*
* **Default is `false`.**
* **Default is `false`**.
*/
isError?: boolean;
/**
Expand Down
2 changes: 1 addition & 1 deletion src/components/InputLabel/InputLabel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export type InputLabelProps = {
/**
* Size of the label.
*
* **Defaults to 'lg'.**
* **Default is `"lg"`**.
*/
size?: Extract<Size, 'md' | 'lg'>;
/**
Expand Down
7 changes: 6 additions & 1 deletion src/components/Modal/Modal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ type ModalContentProps = {
children: ReactNode;
/**
* Hides the close button in the top right of the modal.
*
* **Default is `false`**.
*/
hideCloseButton?: boolean;
/**
Expand All @@ -52,7 +54,8 @@ type ModalContentProps = {
* Prop should be dependent on whether content overflows at the mobile level.
* Tabindex for keyboard scroll is on the body, however, due to focus outline
* not having high contrast on the brand header and being overlapped by the footer.
* Defaults to false since modal default is not scrollable.
*
* **Default is `false`**.
*/
isScrollable?: boolean;
/**
Expand All @@ -75,6 +78,8 @@ type ModalContentProps = {
/**
* Max size of the modal. Defaults to 'lg'.
* Will still break responsively.
*
* **Default is `"lg"`**.
*/
size?: Extract<Size, 'sm' | 'md' | 'lg'>;
/**
Expand Down
4 changes: 2 additions & 2 deletions src/components/NumberIcon/NumberIcon.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ export interface Props {
/**
* The size of the icon.
*
* **Defaults to 'lg'**
* **Default is `"lg"`**.
*/
size?: Extract<Size, 'sm' | 'lg'>;
/**
* The variant of the icon.
*
* **Defaults to 'base'**
* **Default is `"base"`**.
*
* Variant `success` will use a symbol to mark success, along with different color tokens
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/Table/Table.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { StoryObj, Meta } from '@storybook/react';
import React, { useState } from 'react';

// Implementation examples, separated out int separate files
// Implementation examples, separated out into separate files
import { Filters } from './Filters';
import { StackedCardsToTable } from './StackedCardsToTable';

Expand Down
4 changes: 2 additions & 2 deletions src/components/Tag/Tag.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type Props = {
/**
* The color variant of the tag. It will update the content colors, background color, and border (when `hasOutline` is set to `true`).
*
* **Defaults to 'neutral'.**
* **Default is `"neutral"`**.
*/
variant?: Variant;
/**
Expand All @@ -36,7 +36,7 @@ type Props = {
/**
* Adds an outline for the tag.
*
* **Defaults to `false`.**
* **Default is `false`**.
*/
hasOutline?: boolean;
};
Expand Down
2 changes: 1 addition & 1 deletion src/components/Tooltip/Tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ type TooltipProps = {
/**
* Where the tooltip should be placed in relation to the element it's attached to.
*
* **Default is `'top'`.**
* **Default is `"top"`**.
*/
placement?: 'top' | 'right' | 'bottom' | 'left';
/**
Expand Down

0 comments on commit 174aef4

Please sign in to comment.