Skip to content
This repository was archived by the owner on Mar 31, 2020. It is now read-only.

v4.0.0

Choose a tag to compare

@emplums emplums released this 19 Apr 18:34
· 22 commits to master since this release
70f207e

Breaking Changes

  • Next.js dependent components (CodeExample, Frame, NavList, PageLink, RouteMatch, and Router) are now bundled separately and must be imported via the path @primer/blueprints/next-components

  • NavLink now works with or without Next.js. It now takes a next prop and will render a PageLink or Link accordingly. It also takes a currentPath prop to determine whether or not the link is currently being visited..

  • NavList now requires a currentPath prop to determine whether or not links are currently being visited.

  • PackageStatus has been removed as it is too unique to Primer CSS docs and not very resuable.

  • RouteMatch no longer auto-appends paths for child links. Be sure to provide the full path to children nested in a RouteMatch .

  • Section has been removed. It's styling functionality has been moved to SectionLink . Section has auto-appended paths for child links. Be sure to provide the full path to anything you would have nested in Section previously.

  • SectionLink now takes a currentPath prop to bold text for links that are currently being visited. It also takes next prop to either render a PageLink or a Primer Components Link .

  • SideNav no longer nests it's items in a router. This is so that users can provide their own router of choice without being locked into the Next.js router.

  • StatusLabel status props have been renamed to 'stable', 'newRelease', 'experimental', 'inReview', 'deprecated' (now uses camel case).

Enhancements

  • Added the next prop to the Header component. The component now works with or without Next.js
  • Added the next prop to the Search component. The component now works with or without Next.js

Documentation

  • Added documentation for MarkdownHeading , StatusLabel , JumpNav , NavDropdown , NavItem , ResponsiveJumpNav , Search , SectionLink , NavList , RouteMatch, Router and improved documentation for the rest of the components by adding props tables ✨