UITOOL-322 reorganize routes #2309

j-mcgregor · 2021-11-22T18:02:29Z

Proposed Changes

Key Changes

demo/src/components & demo/src/styles are deleted
New routes can be found in demo/src/plasma
Navigation is hardcoded using nested Switches and Routes
- I've tried to organize routes in a way that will make upgrading to React Router v6 easier
- Navigation also uses context as its a more efficient way of accessing the pathname than 65+ useLocations or props drilling on every component
Routes are organized under their corresponding sub navigation categories (layout, navigation, foundations etc)
useMarkdown hook added in each page with corresponding src/plasma/utils/MarkdownDocs.ts imports file for easy-to-add Markdown documentation inside VaporComponent. Pages without Markdown documentation contain a link to Github as per UITOOL-332

Screen.Recording.2021-11-26.at.11.25.09.AM.mov

VaporComponent

Good contender to be refactored and used as the Page Component
useCodeExample hook in VaporComponent

New Layout

- src
    - plasma
        - navigation
            - SideNavigation
        - routes
            - display-and-utilities
                - pages
                  - BordersExamples.tsx
                  - ...
                - index.tsx
            - feedback-and-info
            - foundation
            - input
            - layout
            - navigation
            - legacy (all other components that weren't included in the mockup)
        - utils
        Brand page
        Homepage

I would suggest checking out this branch locally as the structural changes will be easier to see

Fix https://coveord.atlassian.net/browse/UITOOL-329

Potential Breaking Changes

Acceptance Criteria

The proposed changes are covered by unit tests
The potential breaking changes are clearly identified
README.md is adjusted to reflect the proposed changes (if relevant)

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

aiheon · 2021-11-25T15:39:38Z

I have one thing I noticed here 🧐

Peek.2021-11-25.10-38.mp4

j-mcgregor · 2021-11-25T16:20:04Z

I have one thing I noticed here 🧐

Peek.2021-11-25.10-38.mp4

oops, wrapper's in the wrong place, thanks

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

Every page now has a vapor component that takes in markdown from a hook and local md files

moved the necessary functionality to make code blocks for examples in separate file

jenkins-dev-coveo

Stale review, a new push occured on the branch. Check for the new status ⬇️

toofff · 2021-12-01T14:48:56Z

In the section Radio buttons is down for example => https://vapor.coveo.com/feature/PR-2309/index.html#/input/RadioButton
In the section Value Popup this difficult for read this example => https://vapor.coveo.com/feature/PR-2309/index.html#/input/ValuePopup

In the section SubNavigation is down for example => https://vapor.coveo.com/feature/PR-2309/index.html#/navigation/Subnavigation
In the section List Box => https://vapor.coveo.com/feature/PR-2309/index.html#/legacy/ListBox

duplicate example List Box Connected
the example for List Box Connected is between the visual of List Box and the example of List Box

In the section Icons list => https://vapor.coveo.com/feature/PR-2309/index.html#/foundations/Iconography
No example is available, is this normal?

toofff

After small fix is OK for me ;)

jenkins-dev-coveo

Live demo of your latest successful build available here.

jenkins-dev-coveo bot reviewed Nov 22, 2021

View reviewed changes

jenkins-dev-coveo bot reviewed Nov 23, 2021

View reviewed changes

jenkins-dev-coveo bot reviewed Nov 24, 2021

View reviewed changes

j-mcgregor force-pushed the UITOOL-322-reorganize-routes branch from 41fbc7a to 44dbc8f Compare November 25, 2021 14:02

j-mcgregor marked this pull request as ready for review November 25, 2021 14:03

j-mcgregor requested a review from a team as a code owner November 25, 2021 14:03

j-mcgregor requested review from a team, mikedidomizio, gdostie, FelixBlaisThon and aiheon and removed request for a team November 25, 2021 14:03

jenkins-dev-coveo bot reviewed Nov 25, 2021

View reviewed changes

j-mcgregor changed the title ~~UI tool 322 reorganize routes~~ UITOOL-322 reorganize routes Nov 25, 2021

jenkins-dev-coveo bot reviewed Nov 25, 2021

View reviewed changes

Jack added 22 commits November 30, 2021 16:05

feat(vaporcomponent): added markdown and GH link to VC

9cd00d7

Every page now has a vapor component that takes in markdown from a hook and local md files

chore(lockfile): updated lockfile

ff4b6f4

refactor(routes): renamed not-included to legacy, moved nav items

8075d23

chore(modalwindow): renamed modal window

1e249cd

refactor(routes): added tab and modal wizard examples

1686a1e

chore(components): removed components in components dir

5d73217

refactor(pages): added input, feedback and notfound

950e907

chore(styles): removed styles folder

498667c

refactor(pagewithcode): kept and moved the code-block code

d931fd5

moved the necessary functionality to make code blocks for examples in separate file

chore(conflicts): resolving conflicts than rebase

22e632b

refactor(code block): code block working with hook, first pages in

d61a1cb

refactor(input): added withSource to input components

bcae0b9

chore(display): added withSource to display and utilities components

76691ff

chore(feedback): added withSource to feedback components

7642efe

chore(navigation): added withSource for navigation components

4b6d98f

chore(legacy): added withSource to legacy, edited filenames

48b0d77

fix(pages): checking all components have code renders

0e60382

refactor(usage): remove useless usage props

64ea75c

refactor(navigation): cleaned up navigation

17756d8

fix(feedback): git renamed feedbackexamples

a2e5fcb

refactor(renaimg): code block in, renamed some tiltes

bde5618

refactor(reviews): applied reviews

bf84f67

j-mcgregor force-pushed the UITOOL-322-reorganize-routes branch from 5022b8b to bf84f67 Compare November 30, 2021 21:06

jenkins-dev-coveo bot reviewed Nov 30, 2021

View reviewed changes

toofff approved these changes Dec 1, 2021

View reviewed changes

refactor(reviews): applied reviews

f75337d

jenkins-dev-coveo bot reviewed Dec 1, 2021

View reviewed changes

j-mcgregor merged commit d80706f into master Dec 1, 2021

j-mcgregor deleted the UITOOL-322-reorganize-routes branch December 1, 2021 16:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UITOOL-322 reorganize routes #2309

UITOOL-322 reorganize routes #2309

j-mcgregor commented Nov 22, 2021 •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

aiheon commented Nov 25, 2021

j-mcgregor commented Nov 25, 2021

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

toofff commented Dec 1, 2021

toofff left a comment

jenkins-dev-coveo bot left a comment

UITOOL-322 reorganize routes #2309

UITOOL-322 reorganize routes #2309

Conversation

j-mcgregor commented Nov 22, 2021 • edited

Proposed Changes

Key Changes

VaporComponent

New Layout

Potential Breaking Changes

Acceptance Criteria

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

aiheon commented Nov 25, 2021

j-mcgregor commented Nov 25, 2021

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment • edited

Choose a reason for hiding this comment

toofff commented Dec 1, 2021

toofff left a comment

Choose a reason for hiding this comment

jenkins-dev-coveo bot left a comment

Choose a reason for hiding this comment

j-mcgregor commented Nov 22, 2021 •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited

jenkins-dev-coveo bot left a comment •

edited