Skip to content

feat(breadcrumbs): deprecate BreadcrumbContainer and migrate to useBreadcrumb() container #444

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

Merged
merged 2 commits into from
Sep 9, 2019
Merged

feat(breadcrumbs): deprecate BreadcrumbContainer and migrate to useBreadcrumb() container #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec22a72
feat(breadcrumbs): deprecate BreadcrumbContainer and migrate to useBr…
Sep 6, 2019
55cb416
Fix md linting error
Sep 7, 2019
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
1 change: 1 addition & 0 deletions packages/breadcrumbs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"start": "../../utils/scripts/start.sh"
},
"dependencies": {
"@zendeskgarden/container-breadcrumb": "^0.2.2",
"classnames": "^2.2.5"
},
"peerDependencies": {
Expand Down
25 changes: 6 additions & 19 deletions packages/breadcrumbs/src/containers/BreadcrumbContainer.example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
```jsx
const { Anchor } = require('@zendeskgarden/react-buttons/src');
## DEPRECATION WARNING

<BreadcrumbContainer>
{({ getContainerProps }) => (
/* role not needed as `BreadcrumbView` is a navigation landmark. */
<BreadcrumbView {...getContainerProps({ role: null })}>
<List>
<Item>
<Anchor>One</Anchor>
</Item>
<Item>
<Anchor>Two</Anchor>
</Item>
<Item current>Three</Item>
</List>
</BreadcrumbView>
)}
</BreadcrumbContainer>;
```
This component has been deprecated in favor of the API provided in the
[@zendeskgarden/container-breadcrumb](https://www.npmjs.com/package/@zendeskgarden/container-breadcrumb)
package.

This package will be removed in a future major release.
10 changes: 10 additions & 0 deletions packages/breadcrumbs/src/containers/BreadcrumbContainer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@
import { Component } from 'react';
import PropTypes from 'prop-types';

if (process.env.NODE_ENV !== 'production') {
/* eslint-disable no-console */
console.warn(
'Deprecation Warning: The `BreadcrumbContainer` component has been deprecated. ' +
'It will be removed in an upcoming major release. Migrate to the ' +
'`@zendeskgarden/container-breadcrumb` package to continue receiving updates.'
);
/* eslint-enable */
}

export default class BreadcrumbContainer extends Component {
static propTypes = {
/**
Expand Down
15 changes: 6 additions & 9 deletions packages/breadcrumbs/src/elements/Breadcrumb.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
import React, { Component, Children, cloneElement } from 'react';
import PropTypes from 'prop-types';
import { hasType } from '@zendeskgarden/react-utilities';
import { useBreadcrumb } from '@zendeskgarden/container-breadcrumb';

import BreadcrumbContainer from '../containers/BreadcrumbContainer';
import BreadcrumbView from '../views/BreadcrumbView';
import List from '../views/List';
import Item from '../views/Item';
Expand Down Expand Up @@ -44,16 +44,13 @@ export default class Breadcrumb extends Component {

render() {
const { children, ...breadcrumbProps } = this.props;
const { getContainerProps, getCurrentPageProps } = useBreadcrumb();

return (
<BreadcrumbContainer>
{({ getContainerProps, getCurrentPageProps }) => (
/* role not needed as `BreadcrumbView` is a navigation landmark. */
<BreadcrumbView {...getContainerProps({ role: null })}>
<List {...breadcrumbProps}>{this.renderItems(children, getCurrentPageProps)}</List>
</BreadcrumbView>
)}
</BreadcrumbContainer>
/* role not needed as `BreadcrumbView` is a navigation landmark. */
<BreadcrumbView {...getContainerProps({ role: null })}>
<List {...breadcrumbProps}>{this.renderItems(children, getCurrentPageProps)}</List>
</BreadcrumbView>
);
}
}