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

ui-manchette-with-spacetimechart: add ManchetteWithSpaceTimeChart #930

Merged
merged 3 commits into from
Feb 25, 2025

Conversation

emersion
Copy link
Member

@emersion emersion commented Feb 24, 2025

This is a component designed for simple use-cases. It's easier to
use than the hook. Users can still decide to use the hook instead
of this component, especially when they need more customizability.

Other components can be passed in for the header and SpaceTimeChart,
and additional properties can be passed to Manchette/SpaceTimeChart.

This is a breaking API change: the hook is no longer the default
export for ui-manchette-with-spacetimechart. Users need to replace:

import useManchetteWithSpaceTimeChart from 'ui-manchette-with-spacetimechart';

with:

import { useManchetteWithSpaceTimeChart } from 'ui-manchette-with-spacetimechart';

See individual commits.

@emersion emersion requested review from clarani and theocrsb February 24, 2025 13:16
@emersion emersion requested a review from a team as a code owner February 24, 2025 13:16
@emersion emersion self-assigned this Feb 24, 2025
@emersion emersion force-pushed the emr/simple-manchette-with-stc branch from 02e3569 to e4b1831 Compare February 24, 2025 13:17
This type can be useful to osrd-ui users.

Signed-off-by: Simon Ser <[email protected]>
This is a component designed for simple use-cases. It's easier to
use than the hook. Users can still decide to use the hook instead
of this component, especially when they need more customizability.

Other components can be passed in for the header and SpaceTimeChart,
and additional properties can be passed to Manchette/SpaceTimeChart.

This is a breaking API change: the hook is no longer the default
export for ui-manchette-with-spacetimechart. Users need to replace:

    import useManchetteWithSpaceTimeChart from 'ui-manchette-with-spacetimechart';

with:

    import { useManchetteWithSpaceTimeChart } from 'ui-manchette-with-spacetimechart';

Signed-off-by: Simon Ser <[email protected]>
Add a story to demonstrate the use of ManchetteWithSpaceTimeChart.
It behaves the same as the default story.

Signed-off-by: Simon Ser <[email protected]>
@emersion emersion force-pushed the emr/simple-manchette-with-stc branch from e4b1831 to fab0f95 Compare February 24, 2025 13:19
Copy link
Contributor

@theocrsb theocrsb left a comment

Choose a reason for hiding this comment

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

LGTM and tested

Copy link
Contributor

@clarani clarani left a comment

Choose a reason for hiding this comment

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

LGTM, tested ✅

@emersion emersion added this pull request to the merge queue Feb 25, 2025
Merged via the queue into dev with commit bff0ee6 Feb 25, 2025
6 checks passed
@emersion emersion deleted the emr/simple-manchette-with-stc branch February 25, 2025 11:33
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