Giter Club home page Giter Club logo

cbp-style-guide's People

Contributors

davezen1 avatar dependabot[bot] avatar djkianoosh avatar higgo36 avatar higgo3636 avatar jfinest avatar mkayan avatar phirephox avatar r1teshkumar avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cbp-style-guide's Issues

Guide: Components - Copy Revisions (C11-23)

[Breadcrumbs]

C11 - Under "Description" replace text with the following:
Breadcrumbs display the current path to a particular page relative to the starting point. Breadcrumbs provide a means for users to understand their current context in a hierarchical structure and the ability to navigate up the structure easily.

  • Breadcrumbs display the current path as links separated by carets to indicate each level
  • The navigation root is the first element on the left, the current location is the last element to the right
  • The current location is not clickable
  • Clicking on a link takes you to that screen

Depending on the complexity of the navigational hierarchy and the type of page or application, it may make sense for the breadcrumb to represent only part of the hierarchy while sub tabs/trees/navigation represent the remaining hierarchy.

[Buttons]
C12 - Replace the paragraph under "Buttons" with the following text:
Buttons are used as action triggers. Depending on the use case, buttons contain a label and/or an icon. There are a variety of styles, sizes, and variations that can be used for different situations.

All button labels are sentence case. Labels should be as short as possible while clearly explaining what will happen when the button is clicked.

C13 - Change "Button styles" to "Button Styles"
C14 - Change "Button sizes" to "Button Sizes"
C15 - Change the text under Button Sizes to:

  • Large - use the btn-lg class
  • Normal - no extra classes necessary
  • Small - use the btn-sm class
  • Extra small - use the btn-xs class

C16 - Change "Block level buttons" to "Block Level Buttons"
C17 - Change "Button groups" to "Button Groups"
C18 - Change "Toggle buttons" to "Toggle Buttons"
C19 - Change the copy from "Add the active class and the aria-pressed="true" attribute to a button." to "Add the active class and the aria-pressed="true" attribute to a button to visually hold a depressed state."
C20 - Change "Dropdown buttons" to "Dropdown Buttons"
C21 - Change "Split buttons" to "Split Buttons"
C22 - Change "Icon buttons" to "Icon Buttons"
C23 - Change text from "For an icon without chrome, use a btn-hover." to "For an icon without a border, use a btn-hover."

Patterns: Language for all sections

As a developer, I would like the language for the patterns sections to be updated with language and code examples so that I have a better understanding of best practices as it relates to various patterns like Tours, Headers, etc.

Components: Cards Examples

As a user, I would like to see more examples of Cards so that I have a better understanding on where and when to apply the pattern.

Add "Subtle Colors" with Hex value beneath Primary Colors in Foundations section

Introduction of subtle colors that are derivations of primary hues. These are the colors found in alerts, labels and badges.
.tag-danger.subtle {
color: #a00000;
background-color: #f8ecec;
border: 1px solid #f1d9dd;
}

.label-danger.subtle {
color: #a00000;
background-color: #f8ecec;
border: 1px solid #f1d9dd;
}

.alert-danger {
background-color: #f8ecec;
border-color: #f1d9dd;
color: #a00000;
}

$state-success-bg: #ecf5ec !default;
$state-info-bg: #edf3f9 !default;
$state-warning-bg: #fef7ed !default;
$state-danger-bg: #f8ecec !default;
$state-primary-bg: #ecf1f4 !default;

subtle2

subtle

Fix Continuous Integration

As a developer, I need the CI build to build the Style Guide, run checks, and publish the Style Guide to GitHub pages, so that we can ship changes faster.

Updates Examples once a11y updates are complete with the CBP Theme

As a developer, I expect the examples from the kitchen sink to have examples that are in alignment with a11y and the CBP Theme, so that I can use them for development with confidence.

  • We need to carry over the examples from the kitchen sink once the a11y issues are complete.

Guide: Components - Copy Revisions (C1-10)

[Accordions]
C1 - Change "Expand/collapse behaviors" to "Expand/Collapse Behaviors"

[Contextual alerts]
C2 - Change "Contextual alerts" to "Contextual Alerts"
C3 - Under "Description" replace bulleted text with the following:

  • Contextual alerts are positioned above the area or form they relate to
  • They are often triggered by a user interaction
  • They can be closable and can have other action buttons or links
  • Alerts with low importance (info or success) can close automatically after 5 seconds (if desired).
  • Alerts with high importance (warning or danger) should not close automatically, unless the situation has been resolved in some other way.

C4 - Replace example Alert copy with the following:

  • Press the 'A' key to automatically assign a case. ×
  • Case assigned to Jerry [Undo] ×
  • Case assigned to Jerry ×
  • There are more than 10 cases assigned to John ×
  • There was a network error assigning case 90/934,382 [Retry] ×
  • Please fix the 3 errors

C5 - Change "System notifications" to "System Notifications"
C6 - Under "Description" remove the period from the bullet "They can be closable and can have other action buttons or links."
C7 - Under "Types:" replace the bulleted text with the following:

  • Info notifications can be used for general messages that aren’t particularly critical.
  • Success notifications can be used for positive messages that don’t have a context to associate it with.
  • Warning notifications can be used for messages that likely require attention.
  • Danger notifications can be used for critical messages that require immediate attention.

C8 - Replace example System Notification copy with the following:

  • Message sent to Jerry ×
  • Jerry added a comment to one of your cases (90/098,881)
    View comment ×
  • Case 90/842,381 is due tomorrow
    View case Snooze ×
  • Connection has been lost. Retrying in 30 seconds.
    Retry now ×

C9 - Update System Notification code example with (above) grammatical change.
C10 - Double check that the "Toggle notifications" examples of the toast (that appear in the upper right hand corner of the browser) carry the same changes.

Guide: Sidebar Indentation

Increase the indentation between major categories like "Foundations" and sub/child categories like "Colors" in the guide sidebar.

Components: Update Language for All Sections

As a developer, I would like the language for the components sections to be updated with language and code examples so that I have a better understanding of best practices as it relates to various patterns like Buttons, Cards, etc.

Patterns: Tours

As a developer, I would like a common way to create a 'Tour' for the user to showcase application features so that they will have a better user experience.

  • We have looked into Hopscotch, Shephard, and Intro.js.

Menu Component goes over navbar

I was browsing the style guide's section on the menu components. While scrolling through the page, I notice that the example menu elements would go over the style guide's navbar / header bar as you scroll down through the page:

menu_error

Patterns: Add Data Visualization Guidance Section

As a developer, I would like a data visualization section with guidance and examples so that I can apply data visualization best practices.

  • We need to add a section and talk about guidance not necessarily specific libraries.

Ensure all examples are complete

As a developer, I would like the examples to include source code for the html as well as javascript, so that I can easily recreate the functionality from the Style Guide.

  • For all examples where pertinent we need to add html and javascript snippets of code.

Guide: Header Formatting Adjustment

The hamburger button and its backing need to align to height left and right of it. Remove space to left between hamburger button and CBP Style Guide block so it appears seamless.

bad_ham

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.