glide-data-grid icon indicating copy to clipboard operation
glide-data-grid copied to clipboard

Examples are not so helpful

Open Duoquote opened this issue 7 months ago • 1 comments

First of all not to confuse, I am not mad or anything, it's just really not convenient to use storybook examples as reference and I think it's partly an issue of storybook overall, sometimes people don't even bother putting code tab in storybooks. I see there is so much possibility as demonstrated in storybook page, but the examples are at this state are just "showcase", it doesn't provide a direct way to see how the stuff is get done. For example as simple as setting the theme;

Image

I see we need to set theme={theme} prop, but what even is theme object? I have to look through github repository to find what it is.

I feel really sorry to set the title of this issue to Examples are not so helpful but couldn't find anything fit better, it feels like I don't appreciate how great glide-data-grid is, indeed I really like it, it is really fast and very robust as far as I have seen. It's just that would be a lot easier if we could just see the reference code faster. Thanks!

Duoquote avatar Apr 09 '25 06:04 Duoquote

I agree unfortunately. This makes it extremely difficult to understand how to use this library. If the author is going to leave the docs half-assed like this he could at least leave a few notes on how everything is supposed to work. That way if someone else wants to take a crack at cleaning up the docs they can

VEDA95 avatar May 15 '25 22:05 VEDA95

Clone the repo and go to the source code to better understand how the example works.

For this storybook, go here: https://github.com/glideapps/glide-data-grid/blob/630e92af9747f99d083c2abe0b4d36595aeb376f/packages/core/src/docs/examples/theme-support.stories.tsx

It's in the docs examples dir.

charbeltabet avatar Oct 05 '25 17:10 charbeltabet