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

Remove Framer and deprecate EuiNavDrawer family of components #3487

Merged
merged 3 commits into from
May 15, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ types
eui.d.ts
**/*.snap.js
**/assets/**/*.js
package.json
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chandlerprall Need to figure out the a better way to ignore the license header for this file, but keep the rest of the linting intact.

src-docs/src/views/icon/icon_example.js
src-framer/code/canvas.tsx
packages/react-datepicker/examples
1 change: 0 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ wiki/
generator-eui/
test/
src-docs/
src-framer/
packages/react-datepicker
packages/eslint-plugin
.nvmrc
Expand Down
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
- Added exports for `EuiSteps` and related components types ([#3471](https://github.com/elastic/eui/pull/3471))
- Added `displayName` to components using `React.forwardRef` ([#3451](https://github.com/elastic/eui/pull/3451))

**Deprecations**

- Added a deprecation notice for `EuiNavDrawer` family of components. Advise usage of `EuiCollapsibleNav` instead ([#3487](https://github.com/elastic/eui/pull/3487))

**Notes**

- Removed `src-framer` files from the repository ([#3487](https://github.com/elastic/eui/pull/3487))
Comment on lines +11 to +13
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really a breaking change, but not a deprecation. Felt this needed to be marked if one day we want to revisit.


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

- Added `null` as acceptable `icon` prop for `EuiCard` ([#3470](https://github.com/elastic/eui/pull/3470))
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"extract-i18n-strings": "node ./scripts/babel/fetch-i18n-strings",
"lint": "yarn tsc --noEmit && yarn lint-es && yarn lint-sass",
"lint-fix": "yarn lint-es-fix",
"lint-es": "eslint --cache '{src,src-docs,src-framer}/**/*.{ts,tsx,js}' --max-warnings 0",
"lint-es": "eslint --cache '{src,src-docs}/**/*.{ts,tsx,js}' --max-warnings 0",
"lint-es-fix": "yarn lint-es --fix",
"lint-sass": "sass-lint -v --max-warnings 0",
"lint-sass-fix": "sass-lint-auto-fix -c ./.sass-lint-fix.yml",
Expand Down
3 changes: 1 addition & 2 deletions scripts/dtsgenerator.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@ const generator = dtsGenerator({
exclude: [
'node_modules/**/*.d.ts',
'*/custom_typings/**/*.d.ts',
'src-framer/**/*',
'**/*.test.ts',
'**/*.test.tsx',
'**/*.testenv.ts',
'**/*.testenv.tsx',
'src/themes/charts/*' // A separate d.ts file is generated for the charts theme file
'src/themes/charts/*', // A separate d.ts file is generated for the charts theme file
],
resolveModuleId(params) {
if (
Expand Down
26 changes: 25 additions & 1 deletion src-docs/src/views/nav_drawer/nav_drawer_example.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ import { renderToHtml } from '../../services';

import { GuideSectionTypes } from '../../components';

import { EuiNavDrawer, EuiCode, EuiCallOut } from '../../../../src/components';
import {
EuiNavDrawer,
EuiCode,
EuiCallOut,
EuiBadge,
EuiSpacer,
} from '../../../../src/components';

import NavDrawer from './nav_drawer';
const navDrawerSource = require('!!raw-loader!./nav_drawer');
Expand All @@ -30,6 +36,24 @@ export const NavDrawerExample = {
],
text: (
<div>
<EuiBadge
color="danger"
href="https://github.com/elastic/eui/issues/1469"
target="_blank"
iconSide="right"
iconType="popout">
Set for deprecation. See details.
</EuiBadge>
<EuiSpacer />
<p>
Please use{' '}
<Link to="/navigation/collapsible-nav">
<strong>EuiCollapsableNav</strong>
</Link>{' '}
instead of <strong>EuiNavDrawer</strong> for your global navigation
needs. Feature enhancements are no longer being made to this
component.
</p>
<p>
<strong>EuiNavDrawer</strong> provides a side navigation feature
that is complete with interactions and a mobile-friendly design. It
Expand Down
12 changes: 0 additions & 12 deletions src-framer/.eslintrc.js

This file was deleted.

37 changes: 0 additions & 37 deletions src-framer/README.md

This file was deleted.

14 changes: 0 additions & 14 deletions src-framer/code/App.tsx

This file was deleted.

68 changes: 0 additions & 68 deletions src-framer/code/Examples.tsx

This file was deleted.

42 changes: 0 additions & 42 deletions src-framer/code/_framer_helpers/frame_size.tsx

This file was deleted.

46 changes: 0 additions & 46 deletions src-framer/code/_framer_helpers/theme.tsx

This file was deleted.

74 changes: 0 additions & 74 deletions src-framer/code/avatar/avatar.tsx

This file was deleted.

Loading