harmonium icon indicating copy to clipboard operation
harmonium copied to clipboard

As a user, I want the vars & props for the Table component documented on the site

Open blazebarsamian opened this issue 6 years ago • 3 comments

Scenario: Vars Table

  • [ ] Create a new folder in /docs-src/src/pages/components called TableTables
  • [ ] Create a new file in that folder called TableVars.js
  • [ ] Table details:
    • [ ] Table Headers: Variable Name, Default Value, Description
    • [ ] On small screens, there should be a Table.HeadSmall that says Table Vars
    • [ ] The Table Data should include <span>[Column Header]</span> before the table data so that the headers shows on small screens when the table stacks.
    • [ ] Make sure to check the settings file for any vars that were not listed at the top of the components stylesheet.
  • [ ] Import the TableVars file into the main example page: /docs-src/src/pages/components/Table.js
  • [ ] After the ExampleSection include <h3>Variables:</h3>
  • [ ] Then call in the table: <TableVars />

Scenario: Props Table

  • [ ] Create a new file in the TableTables folder called TableProps.js
  • [ ] Table details:
    • [ ] Table Headers: Name, Type, Default, Description
    • [ ] On small screens, there should be a Table.HeadSmall that says Table Props
    • [ ] The Table Data should include <span>[Column Header]</span> before the table data so that the header shows on small screens when the table stacks. Example:
    •  <Table.Data>
          <span>Name:</span> <code>shrink</code>
       </Table.Data>
      
    • [ ] Include all possible props (also check the components file to make sure you didnt miss any props that were not listed on the site.)
  • [ ] Import the TableProps file into the main example page: /docs-src/src/pages/components/Table.js
  • [ ] After the Variables section include <h3>Properties:</h3>
  • [ ] Then call in the table: <TableProps />

blazebarsamian avatar Jun 22 '18 18:06 blazebarsamian

Picking this up to add the props and vars to the bottom of the examples page, thinking about #265 as I'm doing this. I want to make this process as foolproof as possible, will be looking for ways to do that as I'm adding these documentation tables

CheetoMao avatar Jul 02 '18 18:07 CheetoMao

ok! @CheetoMao just make sure when you work on this to use the updated stuff from the tables. Like Table.HeadStacked and <Table.HeaderInline> (instead of the <span>s).

I didnt have time last week to update all of these tickets with that.

Sounds good about #265. I did make sure that the above changes were made in that PR.

blazebarsamian avatar Jul 02 '18 18:07 blazebarsamian

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

revelry-stalebot[bot] avatar Apr 01 '19 17:04 revelry-stalebot[bot]