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.

Sign up for GitHub

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

Jump to bottom

chore(chrome): update prop descriptions #954

Merged
merged 9 commits into from
Dec 17, 2020
Merged

chore(chrome): update prop descriptions #954

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
486a428
Update chrome component prop docs
Mikaelia Dec 15, 2020
12f2145
Doc updates
Mikaelia Dec 15, 2020
a7a3633
Remove redundant word
Mikaelia Dec 16, 2020
720e790
Add missing backticks
Mikaelia Dec 16, 2020
edede97
Complete missing docs
Mikaelia Dec 17, 2020
a513cbf
Add additional missing docs
Mikaelia Dec 17, 2020
8aeb233
Tweak header item prop descriptions
Mikaelia Dec 17, 2020
fc61c57
Update docs per PR comments
Mikaelia Dec 17, 2020
5b813ae
Add cross-reference link
jzempel Dec 17, 2020
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
4 changes: 2 additions & 2 deletions packages/chrome/src/elements/Chrome.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ import { ChromeContext } from '../utils/useChromeContext';
import { StyledChrome } from '../styled';

interface IChromeProps extends HTMLAttributes<HTMLDivElement> {
/** Apply a custom hue to chrome navigation */
/** Applies a custom hue to the chrome navigation */
hue?: string;
/** Prevent fixed positioning from being applied to the <html> element */
/** Prevents fixed positioning from being applied to the `<html>` element */
isFluid?: boolean;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/chrome/src/elements/body/Body.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { BodyContext } from '../../utils/useBodyContext';

interface IBodyProps {
/**
* Prepare the body content height to allow space for a footer component
* Adjusts the body content height to allow space for a footer component
**/
hasFooter?: boolean;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/chrome/src/elements/nav/Nav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { StyledNav } from '../../styled';

interface INavProps extends HTMLAttributes<HTMLElement> {
/**
* Expand navigation area to include item text
* Expands the nav area to display the item text
**/
isExpanded?: boolean;
}
Expand Down
8 changes: 4 additions & 4 deletions packages/chrome/src/elements/nav/NavItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ import { useChromeContext } from '../../utils/useChromeContext';

interface INavItemProps extends HTMLAttributes<any> {
/**
* Applies product-specific color palette
* Applies a product-specific color palette
**/
product?: PRODUCT;
/**
* Indicate which item is current in the nav
* Indicates that the item is current in the nav
**/
isCurrent?: boolean;
/**
* Indicate that the item contains a product logo
* Indicates that the item contains a product logo
*/
hasLogo?: boolean;
/**
* Indicate that the item contains the company brandmark
* Indicates that the item contains the company brandmark
*/
hasBrandmark?: boolean;
}
Expand Down