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

State Of Component Lib #88

Open
6 of 41 tasks
michigg opened this issue May 26, 2023 · 0 comments
Open
6 of 41 tasks

State Of Component Lib #88

michigg opened this issue May 26, 2023 · 0 comments

Comments

@michigg
Copy link
Collaborator

michigg commented May 26, 2023

Rethink code structure

We've added a lot of components without respect or think about the code structure.
The initial idea was to categories the components in

  • atoms
  • molecules
  • templates
    following the atomic design guide. But we've seen that components that are related to each other are visually not related because one of them is a atom and the other a kind of a molecule. So we mixed that up with the last releases. We should rethink our structure and define it.

Dark Mode Breaks some Components

We support dark mode with our color schema, but some components (especially the font color used inside them) seems to be broken. The contrast is really low sometimes.

Missing Tests

Some components are not tested yet.

  • BackLinkTopBar
  • NavBar
  • TopBar
  • ActionButton
  • BaseButton
  • CardDismissButton
  • IconButton
  • InformationButton
  • EntityCard
  • ItemCard
  • WidgetHeadline
  • EntityWrapper
  • ImageGallery
  • InformationHeadline
  • DateTimeInput
  • ImageInputWrapper
  • PreviewImageInput
  • UploadImageFAB
  • LeafletLayer
  • LoadingAnimation
  • WakeLockToggle

Missing Docs

Some components are not documented yet.

  • BaseWidget
  • BaseWidgetEditMode
  • ConfigurableDashboard
  • DashboardBar
  • DynamicGrid
  • EditButton
  • WidgetHeadline
  • WidgetSettingsForm
  • WidgetSettingModal
  • WidgetWrapper
  • widgets
    • IFrameWidget
    • NotFoundWidget
    • RefreshableImageWidget
    • TemplateWidget
    • TwitterWidget
    • weather
  • ImageGallery
  • ImageInputWrapper
  • LeafletLayer

Typescript Bundling

The typescript bundling was broken. The paths inside the dist folder were not resolved. They still contained the @ prefix. We introduced vite-plugin-dts to hotfix the problem. But it throws errors on build. Maybe we can fix that or find a solution without an external lib.

Add Used Libraries Section

We are using multiple libraries now. We should mention them in some way. Maybe we can add a new section on a home page (Did we removed the old one?). Additionally, we should add a note about additional used packages on the docs page of each component if it using some of the optional packages.

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

1 participant