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

🧱 ZUI: Skeleton #2322

Open
2 tasks
Tracked by #2111
ziggabyte opened this issue Oct 31, 2024 · 1 comment
Open
2 tasks
Tracked by #2111

🧱 ZUI: Skeleton #2322

ziggabyte opened this issue Oct 31, 2024 · 1 comment
Labels
❓ needs-info Issue needs further information or decisions before proceeding 🛑 potentially blocked Potentially blocked by prerequisites (double check or ask someone, as it may have changed) 🧱 ZUI Issues related to improvements in reusable ZUI components.

Comments

@ziggabyte
Copy link
Contributor

Description

Skeletons are used to represent content that is on its way, because it is loading.

Screenshots

bild

Figma link

https://www.figma.com/design/yIQMDEFSgkUOrSaJpg3k7N/ZUI?node-id=11045-147081&t=l6edCgukvJ5R7jQM-4
You need to be logged into a Figma account to properly view the Figma content.

Requirements

  • Has three variants, text, circular and rectangular
  • Styles match what is shown in Figma (note for example the rounded corners on the rectangle)

Open questions

None

Workflow

Suggestions for implementation

Use MUI Skeleton component for this.

Git

The main git branch for the work on the new design system is undocumented/new-design-system. Unless otherwise instructed, do your work on a new branch branched off from this branch.

Name your branch issue-number/zui-name, ex: issue-928/zui-button for a branch where work is done that is documented in the issue with number 928, where a button component is being made.

Storybook

Use Storybook to develop the new design system components. If you are not familiar with working with Storybook, please ask and Ziggi or someone else will be happy to introduce you!
When you have checked out the branch undocumented/new-design-system (and, as always when checking out a branch just to be sure, run yarn install), run yarn storybook in the terminal. This starts Storybook locally, and should open your browser to localhost:6006 where you see all the components. Note that you want to only look at the ones under the "Components" headline.

Files

Create a folder in src/zui/components and give it a name for your component, like ZUIButton. Inside that folder, create one file index.tsx (this is where you write your component) and one index.stories.tsx (this is where you write your Storybook stories). Look at the components in src/zui/components for inspiration/reference! Note that there are lots of components with names that start with "ZUI" outside the src/zui/components folder, but only the ones in src/zui/components are relevant as reference/inspiration for the work you will be doing.

@ziggabyte ziggabyte added 🚪 entry-level Good for newcomers 🧱 ZUI Issues related to improvements in reusable ZUI components. 🐟 Small Should be a quick-ish fix. labels Oct 31, 2024
@ziggabyte ziggabyte added ❓ needs-info Issue needs further information or decisions before proceeding 🛑 potentially blocked Potentially blocked by prerequisites (double check or ask someone, as it may have changed) and removed 🚪 entry-level Good for newcomers 🐟 Small Should be a quick-ish fix. labels Dec 10, 2024
@ziggabyte
Copy link
Contributor Author

This issue is set as potentially blocked, because there needs to be a discussion of how ZUI handles loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
❓ needs-info Issue needs further information or decisions before proceeding 🛑 potentially blocked Potentially blocked by prerequisites (double check or ask someone, as it may have changed) 🧱 ZUI Issues related to improvements in reusable ZUI components.
Projects
None yet
Development

No branches or pull requests

1 participant