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

[CCI] Add functionality to OuiBottomBar to have the same width as the container element #708

Conversation

SergeyMyssak
Copy link
Collaborator

@SergeyMyssak SergeyMyssak commented Apr 14, 2023

Description

  1. Added functionality to OuiBottomBar to have the same width as the container element.
Untitled.mov

  1. Fixed the bug in useResizeObserver when the hook failed to immediately detect changes and consequently did not promptly return the intended result.

imgonline-com-ua-twotoone-kvwEt9fjTaP

Issues Resolved

#707

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • All tests pass
    • yarn lint
    • yarn test-unit
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@SergeyMyssak SergeyMyssak changed the title [CCI] Add functionality to OuiBottomBar to have the same width as the container element (#707) [CCI] Add functionality to OuiBottomBar to have the same width as the container element Apr 14, 2023
Copy link
Contributor

@BSFishy BSFishy left a comment

Choose a reason for hiding this comment

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

It looks like this implementation probably fixes the issue, however it introduces a breaking change. What that means is that Dashboards would need to introduce a breaking change (3.0) to update to OUI 2.0, which is not on the roadmap or planned for anytime soon. Ultimately, that means that Dashboards wouldn't be able to consume the fix to the issue, at which point, why are we doing it in the first place.

The fix for the issue needs to be implemented in a backwards-compatible way, such that we only need to cut a minor version bump so that Dashboards is able to pick up the changes.

All in all, I think an approach where we use a resize observer on a specific element ID has a very ugly developer experience, and somewhat breaks React's "componentized" model. I added a few more details in the original issue.

I think in its current state, this PR shouldn't be merged until these concerns are taken care of.

Comment on lines -90 to +112
export const useResizeObserver = (
container: Element | null,
dimension?: 'width' | 'height'
) => {
const [size, _setSize] = useState({ width: 0, height: 0 });
export interface UseResizeObserverProps {
element?: HTMLElement | null;
elementRef?: MutableRefObject<any> | RefObject<any> | null;
elementId?: string;
observableDimension?: 'all' | 'width' | 'height';
shouldObserve?: boolean;
}

export const useResizeObserver = ({
element,
elementRef,
elementId,
observableDimension = 'all',
shouldObserve = true,
}: UseResizeObserverProps) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Changing the prototype like this is a breaking change

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, I know that this is a breaking change. At the moment I can see two ways around this, as only the interface of this function has changed. The first is to create a new hook, the second is to choose how it is processed depending on the container prop type. Is there another way to around this?

@joshuarrrr joshuarrrr added the CCI College Contributor Initiative label Apr 18, 2023
@SergeyMyssak
Copy link
Collaborator Author

Closing this in favour of opensearch-project/OpenSearch-Dashboards#3978

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCI College Contributor Initiative
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants