-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into PBNTR-633-dropdown-available-props-table
- Loading branch information
Showing
25 changed files
with
814 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| [](https://badge.fury.io/js/playbook-ui) | ||
| [](https://badge.fury.io/rb/playbook_ui) | ||
|
|
||
| # Playbook Design System | ||
|
|
||
| Playbook is the first design system built for both Rails & React interfaces. Inspired by [Velocity](https://www.invisionapp.com/inside-design/design-resources/design-system-dashboard-ui-kit/), Playbook takes a modern design approach and applies it in a way that makes it easy to support bleeding edge or legacy systems. Playbook is built & maintained by the User Experience & Development teams at [Power Home Remodeling](https://www.techatpower.com/), the largest home remodeler in the US. | ||
|
|
||
| ## Development | ||
|
|
||
| ### Requirements | ||
|
|
||
| - [asdf](https://github.com/asdf-vm/asdf) | ||
|
|
||
| ### Getting Started and Running Playbook for Development | ||
|
|
||
| 1. After cloning the repo, you should have the following nested folders among other files. It will be important to pay attention to which folder we are in as we get playbook running: | ||
| ``` | ||
| playbook | ||
| │ playbook | ||
| │ playbook-website | ||
| ``` | ||
| 1. Ensure your installed version of `bundler` is the same as the `BUNDLED WITH` section found in [Gemfile.lock](./Gemfile.lock). You can check the version you have by running `bundle -v`. | ||
| 1. From the root directory, run `./setup.sh` | ||
| 1. From the top-level playbook folder run `yarn start-dev` This may take a little while. | ||
| 1. Once you see the "compiled successfully" message in your terminal, navigate to [http://localhost:3000](http://localhost:3000) and you should see the playbook website. | ||
| ### Post Installation Startup | ||
| Use `./run.sh` to run the application in one step. This will handle dependency updates then start the server. Helpful for fast start-up without bootstrapping especially when switching branches. 🚀 | ||
| ### Running Library Tests | ||
| 1. `cd playbook && ./test.sh` | ||
| --- | ||
| ## Additional Resources | ||
| ### Adding NPM Dependencies | ||
| 1. You need to be working in `playbook/playbook` or `playbook/playbook-website` subdirectory | ||
| 1. run `yarn workspace playbook-website add <lib name>` to add to the website | ||
| 1. run `yarn workspace playbook-ui add <lib name>` to add to the kit source | ||
| 1. run `yarn workspace playbook-project add <lib name>` to add to the main project | ||
| ### Upgrading between versions | ||
| See [docs/upgrade-guide](./upgrade-guide) | ||
| ### Releases | ||
| * [Playbook Releases](https://github.com/powerhome/playbook/wiki/Playbook-Releases) | ||
| ### Development Environment | ||
| * [Common Errors & Solutions](https://github.com/powerhome/playbook/wiki/Common-Errors-&-Solutions) | ||
| ### Building Playbook Kits | ||
| * [Generating a Kit](https://github.com/powerhome/playbook/wiki/Generating-a-Kit) | ||
| * [Rails Kit](https://github.com/powerhome/playbook/wiki/Rails-Kit) | ||
| * [Rails Kit Helpers](https://github.com/powerhome/playbook/wiki/Rails-Kit-Helpers) | ||
| * [Using a Kit within a Kit](https://github.com/powerhome/playbook/wiki/Using-a-Kit-within-a-Kit) | ||
| * [Understanding Rails Kit HTML Wrapper](https://github.com/powerhome/playbook/wiki/Understanding-Rails-Kit-HTML-Wrapper) | ||
| * [Kit Stylesheet](https://github.com/powerhome/playbook/wiki/Kit-Stylesheet) | ||
| ### Testing Playbook Kits Locally | ||
| #### Testing React Kits locally | ||
| 1. From inside the `playbook-ui` directory, run `yarn link`; | ||
| 1. From Inside the project you want to test with `playbook-ui`, run `yarn link playbook-ui`; | ||
| 1. Rebuild the project now using this version of `playbook-ui`; | ||
| 1. Test all the things! | ||
| 1. When finished, from inside the project you were testing with `playbook-ui`, run `yarn unlink playbook-ui`; | ||
| 1. From Inside the `playbook-ui` directory, run `yarn unlink`; | ||
| #### Jest & React-Testing-Library for Writing Tests | ||
| We are currently backfilling test cases for React kit test coverage using Jest and React Testing Library. More additions and enhancements | ||
| to the testing libraries are currently in the works. In the meantime, please take a look at these resources: | ||
| - https://github.com/testing-library/jest-dom#usage for usage and examples | ||
| - https://jestjs.io/docs/en/using-matchers | ||
| When a new kit is generated, a placeholder React kit test will also be created. You can run all the tests with `yarn test`. | ||
| ### Important Note | ||
| Keep in mind: Styles are brought in from playbook through the rails gem, so you will not be able to test scss updates with yarn linking. | ||
| The gem & npm package is available as open source under the terms of the [ISC License](https://opensource.org/licenses/ISC). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| @import "../tokens/colors"; | ||
| @import "../tokens/line_height"; | ||
| @import "../tokens/typography"; | ||
| @import "../tokens/border_radius"; | ||
|
|
||
| [class^=pb_link_kit]{ | ||
| @include pb_link($primary); | ||
| &:hover { | ||
| color: $text_lt_default; | ||
| } | ||
| &:focus { | ||
| outline: none; | ||
| } | ||
| &:focus-visible { | ||
| border-radius: $border_rad_light; | ||
| outline: 1px solid $primary; | ||
| outline-offset: 2px; | ||
| } | ||
| &:visited { | ||
| color: $data_3; | ||
| } | ||
| &.dark { | ||
| @include pb_link($active_dark); | ||
| &:hover { | ||
| color: $text_dk_default; | ||
| } | ||
| } | ||
| @each $color_name, $color_value in $pb_link_colors { | ||
| &[class*=_#{"" + $color_name}] { | ||
| @include pb_link($color_value); | ||
|
|
||
| &:hover { | ||
| color: map-get($pb_link_hover_colors, $color_name); | ||
| } | ||
|
|
||
| &:visited { | ||
| color: $data_3; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @each $dark_color_name, $dark_color_value in $pb_dark_link_colors{ | ||
| &[class*=_#{$dark_color_name}][class*=dark]{ | ||
| @include pb_link($dark_color_value); | ||
|
|
||
| &:hover { | ||
| color: map-get($pb_dark_link_hover_colors, $dark_color_name); | ||
| } | ||
|
|
||
| &:visited { | ||
| color: $data_3; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| &[class*=_underline] { | ||
| text-decoration: underline; | ||
| } | ||
|
|
||
| &[class*=_disabled] { | ||
| pointer-events: none; | ||
| cursor: default; | ||
| color: $text_lt_lighter; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| import React from 'react' | ||
| import classnames from 'classnames' | ||
|
|
||
| import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from '../utilities/props' | ||
| import { globalProps, GlobalProps } from '../utilities/globalProps' | ||
|
|
||
| import Icon from '../pb_icon/_icon' | ||
|
|
||
| type LinkProps = { | ||
| aria?: {[key: string]: string}, | ||
| className?: string, | ||
| children?: React.ReactChild[] | React.ReactChild, | ||
| color?: 'default' | 'body' | 'muted' | 'destructive', | ||
| dark?: boolean, | ||
| data?: {[key: string]: string}, | ||
| disabled?: boolean, | ||
| href?: string, | ||
| htmlOptions?: {[key: string]: string | number | boolean | (() => void) | ((arg?: Event) => void)}, | ||
| icon?: string, | ||
| iconRight?: string, | ||
| id?: string, | ||
| tag?: 'a' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'div', | ||
| text?: string, | ||
| underline?: boolean, | ||
| } & GlobalProps | ||
|
|
||
| const Link = (props: LinkProps): React.ReactElement => { | ||
| const { | ||
| aria = {}, | ||
| children, | ||
| className, | ||
| color = '', | ||
| data = {}, | ||
| disabled = false, | ||
| href= '', | ||
| htmlOptions = {}, | ||
| icon = '', | ||
| iconRight = '', | ||
| id = '', | ||
| tag = 'a', | ||
| text = '', | ||
| underline = false, | ||
| } = props | ||
|
|
||
| const ariaProps: {[key: string]: string} = buildAriaProps(aria) | ||
| const dataProps: {[key: string]: string} = buildDataProps(data) | ||
| const htmlProps = buildHtmlProps(htmlOptions); | ||
| const classes = classnames( | ||
| buildCss('pb_link_kit', color, underline ? 'underline' : '', disabled ? 'disabled' : ''), | ||
| globalProps(props), | ||
| className | ||
| ) | ||
| const Tag = tag as keyof JSX.IntrinsicElements | ||
|
|
||
| const renderContent = () => ( | ||
| <> | ||
| {icon && ( | ||
| <Icon | ||
| fixedWidth | ||
| icon={icon} | ||
| marginRight="xxs" | ||
| size="xs" | ||
| /> | ||
| )} | ||
| {text || children} | ||
| {iconRight && ( | ||
| <Icon | ||
| fixedWidth | ||
| icon={iconRight} | ||
| marginLeft="xxs" | ||
| size="xs" | ||
| /> | ||
| )} | ||
| </> | ||
| ) | ||
|
|
||
| const commonProps = { | ||
| ...ariaProps, | ||
| ...dataProps, | ||
| ...htmlProps, | ||
| className: classes, | ||
| id, | ||
| } | ||
|
|
||
| if (tag === 'a') { | ||
| return ( | ||
| <a | ||
| {...commonProps} | ||
| href={href} | ||
| > | ||
| {renderContent()} | ||
| </a> | ||
| ) | ||
| } else { | ||
| return ( | ||
| <a | ||
| {...commonProps} | ||
| href={href} | ||
| > | ||
| <Tag>{renderContent()}</Tag> | ||
| </a> | ||
| ) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| export default Link |
Oops, something went wrong.