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

feat: add component catalog base #54

Merged
merged 29 commits into from
Nov 8, 2021
Merged

Conversation

andreancardona
Copy link
Contributor

@andreancardona andreancardona commented Oct 27, 2021

Closes #12

Related to #8

Changelog

New

  • Adds in Catalog List View
  • Adds in Catalog Grid View
  • Breaks up each component into their own directory and stylesheet

Testing / reviewing

  • Make sure you see both view styles for the component catalog at all the breakpoints

Screen Shot 2021-11-08 at 11 30 11 AM

Note:

  • This does not include functionality
  • Still missing filter and search, pagination styling & functionality

@andreancardona andreancardona requested a review from a team as a code owner October 27, 2021 18:08
@andreancardona andreancardona marked this pull request as draft October 27, 2021 18:08
@andreancardona andreancardona changed the title [DRAFT PR - DO NOT MERGE]feat: add component catalog base [DRAFT PR - DO NOT MERGE] feat: add component catalog base Oct 27, 2021
Copy link
Member

@mattrosno mattrosno left a comment

Choose a reason for hiding this comment

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

@andreancardona can this PR close #12, so we don't have to wait to merge this until the full prototype is done?

.eslintrc.js Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@mattrosno mattrosno changed the title [DRAFT PR - DO NOT MERGE] feat: add component catalog base feat: add component catalog base Oct 27, 2021
@mattrosno
Copy link
Member

@andreancardona I updated PR name because we can't merge this if we wanted to, until you mark the PR as "Ready for review."

@andreancardona andreancardona marked this pull request as ready for review October 28, 2021 20:02
@mattrosno
Copy link
Member

@andreancardona weird - not sure why GitHub here didn't say that this branch was behind main... I just merged in main branch and fixed the build that was breaking due to notice linting.

Copy link
Member

@mattrosno mattrosno left a comment

Choose a reason for hiding this comment

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

Next.js file naming convention is to use lowercase dashed file names like component-catalog.js instead of ComponentCatalog.js. Not a big deal right now, but let's standardize on that going forward.

I'm thinking these components can go in a /components/catalog directory, as the catalog components will be not specific to components... they will be used in the Elements catalog, Patterns catalog, etc. All asset catalogs.

Actually, we can split these components up to their own directories so each components can have its own CSS Modules file. That way, we can use short class names like styles.container and not need styles.componentCatalogItemGridContainer.

- add .env.example back in which should not be deleted
- disable :global stylelint
mattrosno
mattrosno previously approved these changes Oct 28, 2021
Copy link
Member

@mattrosno mattrosno left a comment

Choose a reason for hiding this comment

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

Looking good! Lmk if you want to pair up to do any of these recommendations.

- TODO for me: add a pre-commit hook or ci check to ensure we only ever have one lock file
.eslintrc.js Outdated Show resolved Hide resolved
@jharvey10
Copy link
Contributor

Looks like there's just two minor code smells. One for commented out code and another for an expression that can be returned instead of being assigned to a local variable.
Should be easily fixable!

@andreancardona
Copy link
Contributor Author

andreancardona commented Nov 4, 2021

Next.js file naming convention is to use lowercase dashed file names like component-catalog.js instead of ComponentCatalog.js. Not a big deal right now, but let's standardize on that going forward.

I'm thinking these components can go in a /components/catalog directory, as the catalog components will be not specific to components... they will be used in the Elements catalog, Patterns catalog, etc. All asset catalogs.

Actually, we can split these components up to their own directories so each components can have its own CSS Modules file. That way, we can use short class names like styles.container and not need styles.componentCatalogItemGridContainer.

  • Next.js file naming convention is to use lowercase dashed file names like component-catalog.js instead of ComponentCatalog.js. Not a big deal right now, but let's standardize on that going forward.

I'm thinking these components can go in a /components/catalog directory, as the catalog components will be not specific to components... they will be used in the Elements catalog, Patterns catalog, etc. All asset catalogs.

  • Actually, we can split these components up to their own directories so each components can have its own CSS Modules file. That way, we can use short class names like styles.container and not need styles.componentCatalogItemGridContainer.

@sonarcloud
Copy link

sonarcloud bot commented Nov 8, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.7% 0.7% Duplication

@mattrosno mattrosno merged commit 9ffe154 into main Nov 8, 2021
@mattrosno mattrosno deleted the feat/add-component-catalog-base branch November 8, 2021 18:58
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.

Create components needed for asset catalogs
3 participants