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.

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

More clearly mark EuiPageSideBarProps as deprecated #6468

Merged
merged 2 commits into from
Dec 7, 2022

Conversation

cee-chen
Copy link
Contributor

@cee-chen cee-chen commented Dec 7, 2022

Summary

@spalger pointed out that we are exporting both EuiPageSideBarProps (deprecated) and EuiPageSidebarProps (the new one), which is super confusing for consumers and Kibana.

It looks like Caroline missed renaming EuiPageSideBarProps to deprecated to match EuiPageSideBar (she marked other similar/confusing props as _Deprecated), so this PR amends that.

export type { EuiPageSideBarProps } from './page_side_bar';
export { EuiPageSideBar_Deprecated } from './page_side_bar';

export type { EuiPageTemplateProps_Deprecated } from './page_template';
export { EuiPageTemplate_Deprecated } from './page_template';

QA

General checklist

  • Linting/tests pass
  • A changelog entry exists and is marked appropriately

- it's causing confusion in Kibana
@cee-chen cee-chen requested a review from spalger December 7, 2022 17:32
@cee-chen cee-chen enabled auto-merge (squash) December 7, 2022 17:35
@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_6468/

@cee-chen cee-chen merged commit 46ec00f into elastic:main Dec 7, 2022
@cee-chen cee-chen deleted the pagesidebar-deprecated-props branch December 7, 2022 18:23
jbudz pushed a commit to elastic/kibana that referenced this pull request Dec 22, 2022
## Summary

`[email protected]` ⏩ `[email protected]`

---

## [`72.0.0`](https://github.com/elastic/eui/tree/v72.0.0)

- Added the `customQuickSelectRender` render prop to
`EuiSuperDatePicker`, which allows customizing the Quick Select popover
([#6382](elastic/eui#6382))
- `EuiFilePicker` styles have been updated to look more like an
interactive element. ([#6479](elastic/eui#6479))
- Added a third argument to `EuiSelectable`'s `onChange` callback. The
single `option` object that triggered the `onChange` event is now also
passed to consumers with its most recent `checked` state
([#6487](elastic/eui#6487))

**Bug fixes**

- `EuiTabs` now passes `size` and `expand` to all children using a React
context provider. ([#6478](elastic/eui#6478))
- Fixed security warnings caused by `[email protected]` sub-dependency
([#6482](elastic/eui#6482))

**Breaking changes**

- Removed `size` and `expand` props from `EuiTab`
([#6478](elastic/eui#6478))

## [`71.1.0`](https://github.com/elastic/eui/tree/v71.1.0)

**Deprecations**

- Renamed `EuiPageSideBarProps` to `EuiPageSideBarProps_Deprecated`, to
reduce usage/confusion with `EuiPageSidebar`
([#6468](elastic/eui#6468))

Co-authored-by: Kibana Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants