Skip to content

[EuiPageTemplates] Some fixes for BWC#6015

Merged
cchaos merged 10 commits intoelastic:feature/page_templatesfrom
cchaos:_page_next/fix_deprecated
Aug 2, 2022
Merged

[EuiPageTemplates] Some fixes for BWC#6015
cchaos merged 10 commits intoelastic:feature/page_templatesfrom
cchaos:_page_next/fix_deprecated

Conversation

@cchaos
Copy link
Copy Markdown
Contributor

@cchaos cchaos commented Jun 30, 2022 •
edited
Loading

Note
I'm testing this PR against Kibana locally and I'm hopeful we have something we can finally publish to Kibana without too much worry about negative effects.

EuiPageTemplate

  • Added mainProps to support custom id and other basic HTML attributes to be passed to the inner / <main> content wrapper

EuiPageSection

  • Fixed the restrictWidth rendered styles for custom values
  • Reduced complexity of margin styles
  • Converted to use logical properties

EuiPageTemplate.Sidebar

  • Fixed the overflow scroll by setting height to auto instead of 100%.

EuiPageTemplate.BottomBar

  • Now excludes paddingSize from being passed through since this affects all 4 sides and un-aligns the contents to the page contents. If consumers want to adjust, they can pass their own style overrides.
  • Moved inline styles to css block and added overflow: hidden in case the contents contains negative margins (like flex groups) that are larger than the padding area.

EuiPageTemplate__Deprecated

  • Because I removed the nested styles that would apply margin after page headers within page body, I wanted to keep some level of BWC with current implementations of the template by manually adding in bottom margin based on the configuration and paddingSize.
  • Added a "Deprecated" section (and playground) to the docs so we can monitor any unexpected changes

Screen Shot 2022-06-23 at 14 45 52 PM

Other

  • Added height as an option to the euiYScroll() mixins to easily change from 100% to something else.
  • Removed this feature's own version of euiBreakpoint Emotion mixin
  • Fixed docs site 404 illustrations
  • Fixed Screen reader live docs’ usage of EuiPageTemplate

Checklist

  • Checked in both light and dark modes
  • Checked in mobile
  • [ ] Checked in Chrome, Safari, Edge, and Firefox
  • Props have proper autodocs and playground toggles
  • Added documentation
  • [ ] Checked Code Sandbox works for any docs examples
  • Added or updated jest and cypress tests
  • [ ] Checked for breaking changes and labeled appropriately
  • Checked for accessibility including keyboard-only and screenreader modes
  • [ ] Updated the Figma library counterpart
  • [ ] A changelog entry exists and is marked appropriately

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jun 30, 2022

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

cchaos added 2 commits July 26, 2022 14:08
Merge remote-tracking branch 'upstream/feature/page_templates' into _…
d66b691 
…page_next/fix_deprecated
Fixes from main update
73ee302 
- Adds `mainProps` to EuiPageTemplate for allowing customization of things like `id` (for skip link)
- Fixed docs site 404 illustrations
- Removed old `euiBreakpoint` for new one
- Fixed Screen reader live docs’ usage of EuiPageTemplate
@cchaos cchaos marked this pull request as ready for review July 27, 2022 15:29
@cchaos
Copy link
Copy Markdown
Contributor Author

cchaos commented Jul 27, 2022

Ok, this PR is ready for review. Once merged into the Feature branch, I'll do one final pass through the entire checklist including the final CL items and Kibana local test.

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jul 27, 2022

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

@thompsongl thompsongl self-requested a review July 27, 2022 16:22
elizabetdev
elizabetdev suggested changes Jul 28, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev left a comment

Choose a reason for hiding this comment

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

I looked at the code and tested it locally in Chrome, Safari, and Firefox.

There's a local warning that must be resolved:

Warning: React does not recognize the `innerProps` prop on a DOM element.

I also added some suggestions and all the rest looks good to me. 🎉

cchaos
cchaos commented Jul 28, 2022
View reviewed changes
src-docs/src/views/page_template/deprecated.tsx
@@ -0,0 +1,30 @@
import React, { useState } from 'react';

import { EuiPageTemplate_Deprecated as EuiPageTemplate } from '../../../../src';
Copy link
Copy Markdown
Contributor Author

@cchaos cchaos Jul 28, 2022

Choose a reason for hiding this comment

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

It looks like the GREP mechanism for the imports of the source code doesn't understand this as syntax and is adding commas between:
Screen Shot 2022-07-28 at 13 58 20 PM

Anyone know of a quick fix?

Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev Jul 28, 2022

Choose a reason for hiding this comment

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

My attempt to fix this. Replace the following code:

eui/src-docs/src/components/guide_section/_utils.js

Line 55 in af5590e

const combinedImports = elasticImports.join(', ');

With:

const combinedImports = elasticImports.includes('as')
      ? elasticImports.join(' ')
      : elasticImports.join(',\n  ');

But better @thompsongl comes with a better solution. 🤣

Copy link
Copy Markdown
Contributor

@thompsongl thompsongl Jul 28, 2022

Choose a reason for hiding this comment

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

865cf85 should do it

Copy link
Copy Markdown
Contributor Author

@cchaos cchaos Jul 28, 2022

Choose a reason for hiding this comment

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

🙌 Yoda best!

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jul 28, 2022

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

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jul 28, 2022

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

thompsongl
thompsongl approved these changes Aug 1, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@thompsongl thompsongl left a comment

Choose a reason for hiding this comment

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

Code changes LGTM!

@cchaos cchaos requested a review from elizabetdev August 1, 2022 17:10
elizabetdev
elizabetdev approved these changes Aug 2, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev left a comment

Choose a reason for hiding this comment

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

Thanks, @cchaos! LGTM! 🎉

@cchaos cchaos merged commit cc1c6ed into elastic:feature/page_templates Aug 2, 2022
@cchaos cchaos deleted the _page_next/fix_deprecated branch August 2, 2022 14:10
@cchaos cchaos mentioned this pull request Aug 8, 2022
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@thompsongl thompsongl thompsongl approved these changes

@elizabetdev elizabetdev elizabetdev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@cchaos @kibanamachine @thompsongl @elizabetdev