feat: add worksheet docs #562
Conversation
jorgemoya
force-pushed
the
worksheet-documentation
branch
from
e0fb0c8 to
bf91077
Compare
| name: 'hash', | ||
| types: 'string', | ||
| required: true, | ||
| description: 'Unique identifier for column.', |
There was a problem hiding this comment.
Could we describe this prop a bit more? What are it's usages et. al.?
There was a problem hiding this comment.
It is only used internally, do we need to tell them it is used to manipulate the cells? I copied this from Table btw.
There was a problem hiding this comment.
I guess it is also used on the rows, so that there is some structure present?
There was a problem hiding this comment.
My main concern is that it's a required prop, without really explaining why the consumer needs to use it. I'm trying to approach this from a perspective of a consumer that doesn't really know the internal implementation here; they just need it to work, but understand a little why.
There was a problem hiding this comment.
I don't know if I agree with this, we rarely (if ever) indicate why an id is required. It can be inferred the component uses it internally.
There was a problem hiding this comment.
Updated for some more info, let me know what you think.
There was a problem hiding this comment.
Well for instance, we have the Dropdown component which it's items have a hash prop. The components implementation doesn't use hash at all (if you search the repo) and the description of the prop is Stored hash of the item.. I know that is specific to the Dropdown, but as a consumer, it doesn't give me any knowledge of what it's used for. For the worksheet I want to avoid stuff like this, in case we drop support for hash or etc.. It should be clear what the intended purpose is.
There was a problem hiding this comment.
What about this?
Unique identifier for the column value of each row. Used internally to identify and manage state values.
| name: 'header', | ||
| types: 'string', | ||
| required: true, | ||
| description: 'Header title.', |
There was a problem hiding this comment.
🍹 Maybe make this a little bit more descriptive? Maybe you can think of something better?
| description: 'Header title.', | |
| description: 'Header for the column.', |
| }, | ||
| { | ||
| name: 'type', | ||
| types: ['text'], |
There was a problem hiding this comment.
I would check some of these types key/values to see if you can just have them as a string instead of an array.
| types: ['text'], | |
| types: 'text', |
jorgemoya
force-pushed
the
worksheet-documentation
branch
from
8119b87 to
def79a1
Compare
What?
Adds Worksheet documentation
Screenshots/Screen Recordings