@brightspace-ui-labs/carded-table
v2.0.0
Published
Carded table component
Downloads
813
Keywords
Readme
d2l-labs-carded-table
Note: this is a "labs" component. While functional, these tasks are prerequisites to promotion to BrightspaceUI "official" status:
- [ ] Design organization buy-in
- [ ] design.d2l entry
- [ ] Architectural sign-off
- [x] Continuous integration
- [x] Cross-browser testing
- [x] Unit tests
- [x] Accessibility tests
- [ ] Visual diff tests
- [x] Localization with Serge (N/A)
- [x] Demo page
- [x] README documentation
Carded table component for displaying content as rows of cards. "Cells" in the table are aligned to the column headers.
Installation
To install from NPM:
npm install @brightspace-ui-labs/carded-table
Usage
<script type="module">
import '@brightspace-ui-labs/carded-table/carded-table-card.js';
import '@brightspace-ui-labs/carded-table/carded-table-cards.js';
import '@brightspace-ui-labs/carded-table/carded-table-header.js';
import '@brightspace-ui-labs/carded-table/carded-table-heading.js';
import '@brightspace-ui-labs/carded-table/carded-table.js';
</script>
<d2l-labs-carded-table default-columns>
<d2l-labs-carded-table-header>
<d2l-labs-carded-table-heading>Column 1</d2l-labs-carded-table-heading>
<d2l-labs-carded-table-heading>Column 2</d2l-labs-carded-table-heading>
</d2l-labs-carded-table-header>
<d2l-labs-carded-table-cards>
<d2l-labs-carded-table-card>
<div>Card 1 Element 1</div>
<div>Card 1 Element 2</div>
</d2l-labs-carded-table-card>
<d2l-labs-carded-table-card>
<div>Card 2 Element 1</div>
<div>Card 2 Element 2</div>
</d2l-labs-carded-table-card>
</d2l-labs-carded-table-cards>
</d2l-labs-carded-table>
Properties & Info
d2l-labs-carded-table
default-columns
: Automatically addsgrid-template-column
to the header and card elements, based on the number of headings. Defaults to1fr
width for each column.- e.g., in the demo above,
grid-template-columns: repeat(2, 1fr)
would be added.
- e.g., in the demo above,
For custom column sizes, add your own
grid-template-column
to both thed2l-labs-carded-table-header
andd2l-labs-carded-table-card
elements.(See
demo/carded-table-course-demo.js
for an example)
d2l-labs-carded-table-header
- Wrapper for headings - apply the
grid-template-columns
on this element to line up content in the cards.
d2l-labs-carded-table-heading
- This contains the content of the heading.
d2l-labs-carded-table-card
- This contains the content that appears in the cards. The number of 'cells' should line up with the number of columns specified.
Developing, Testing and Contributing
After cloning the repo, run npm install
to install dependencies.
Running the demos
To start a @web/dev-server that hosts the demo page and tests:
npm start
Linting
# eslint
npm run lint
Testing
# lint & run headless unit tests
npm test
# unit tests only
npm run test:headless
Versioning and Releasing
This repo is configured to use semantic-release
. Commits prefixed with fix:
and feat:
will trigger patch and minor releases when merged to main
.
To learn how to create major releases and release from maintenance branches, refer to the semantic-release GitHub Action documentation.