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

Create style guide #35

Closed
4 tasks done
briri opened this issue Apr 30, 2024 · 5 comments
Closed
4 tasks done

Create style guide #35

briri opened this issue Apr 30, 2024 · 5 comments
Assignees

Comments

@briri
Copy link
Collaborator

briri commented Apr 30, 2024

The “living” styleguide will serve as a common place where any developer,
designer and even testers can look at the different components used in the app.
Developers can use the styleguide to develop functionality for their components,
without having to rely on certain front-end pages to be completed first.

  • Decide on a Structure

My immediate thoughts are that the structure in the beginning can just be a
single page, and we can just scroll to the components we want. A navbar could
help jump to a specific component.

As the list of components grow, we can potentially group related components
together on their own pages.

  • Create the page structure and add some initial components
  • For core library components, if we didn't add any custom styling to them, add a link to the core library component documentation so that developers can see how to use the component.
  • Documentation should include any /css variables/ that can change the look
    of the component.
@andrewebdev andrewebdev self-assigned this Apr 30, 2024
@jupiter007
Copy link
Collaborator

Hi @andrewebdev. The TypeAhead.jsx component that I created for the dmptool is here, https://github.com/CDLUC3/dmptool/blob/v5/react-client/src/components/TypeAhead.jsx, and works with the backend that lives in the current dmptool repo.

I think it's best to wait to add this component to the style guide until we are developing a page with a TypeAhead field and we have an available endpoint to call.

@briri
Copy link
Collaborator Author

briri commented May 29, 2024

I had started work on a ticket that pulls in the institution information from ROR. We can point the typeahead field at that. We will need it anyway for the upcoming authentication work. We can reprioritize that for the next sprint.

@mariapraetzellis
Copy link

@jupiter007 will take a look and update the ticket with the current status.

@jupiter007
Copy link
Collaborator

@andrewebdev - I approved your PR.

@briri briri closed this as completed Jun 27, 2024
@briri briri reopened this Jun 27, 2024
@briri
Copy link
Collaborator Author

briri commented Jun 27, 2024

reopening so this stays on the board so we can review completed tasks at the end of the sprint

@bofstein bofstein closed this as completed Jul 8, 2024
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

No branches or pull requests

5 participants