4.4.9 • Published 8 months ago

@conectate/ct-card v4.4.9

Weekly downloads
9
License
BSD-3-Clause
Repository
github
Last release
8 months ago

Published on webcomponents.org

ct-card

A stylized container component that provides a surface for displaying content.

Installation

To include this, type:

$ pnpm i @conectate/ct-card
# or
$ npm i @conectate/ct-card

Usage

<!-- Basic card -->
<ct-card>Basic card</ct-card>

<!-- With decorator (top border) -->
<ct-card decorator>Card with decorator</ct-card>

<!-- With border -->
<ct-card withborder>Card with border</ct-card>

<!-- With padding -->
<ct-card padding>Card with padding</ct-card>

<!-- With theme -->
<ct-card primary>Primary themed card</ct-card>
<ct-card secondary>Secondary themed card</ct-card>
<ct-card tertiary>Tertiary themed card</ct-card>
<ct-card error>Error themed card</ct-card>

Using Card Content and Actions

<ct-card>
	<div class="card-content">This is the main content of the card.</div>
	<div class="card-actions">
		<button>Action 1</button>
		<button>Action 2</button>
	</div>
</ct-card>

Theming

This component uses CSS custom properties for theming:

PropertyDescription
--border-radiusBorder radius of the card (default: 16px)
--color-surfaceBackground color
--color-on-surfaceText color
--color-primary-containerBackground for primary variant
--color-on-primary-containerText color for primary variant
--color-secondary-containerBackground for secondary variant
--color-on-secondary-containerText color for secondary variant
--color-tertiary-containerBackground for tertiary variant
--color-on-tertiary-containerText color for tertiary variant
--color-error-containerBackground for error variant
--color-on-error-containerText color for error variant
--color-outlineBorder color when using withborder attribute
--color-appColor for the decorator (top border)
--ct-card-box-shadowCustom box-shadow when using shadow attribute

API

Properties

PropertyTypeDefaultDescription
decoratorBooleanfalseAdd border-top with color-app
withborderBooleanfalseAdd border around the card
primaryBooleanfalseApply primary theme colors
secondaryBooleanfalseApply secondary theme colors
tertiaryBooleanfalseApply tertiary theme colors
errorBooleanfalseApply error theme colors
shadowBooleanfalseAdd box-shadow (deprecated)
paddingBooleanfalseAdd 16px padding to the card

Slots

NameDescription
(default)Main content area of the card

CSS Classes

You can use these classes inside the card to get predefined styles:

ClassDescription
.card-actionsFor action buttons (adds top border)
.card-contentFor content (adds padding)

Follow me

Herberth Obregón

https://x.com/herberthobregon

https://dev.to/herberthobregon

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

  • v1.0.1 Initial Release

License

See LICENSE

4.4.9

8 months ago

4.3.2

11 months ago

4.4.0

10 months ago

4.3.4

11 months ago

4.3.3

11 months ago

4.3.0

11 months ago

4.1.0

1 year ago

4.0.0

1 year ago

3.13.1

2 years ago

3.8.0

2 years ago

3.10.0

2 years ago

3.12.0

2 years ago

3.9.0

2 years ago

3.12.8

2 years ago

3.7.0

3 years ago

3.6.0

4 years ago

3.5.11

4 years ago

3.5.0

4 years ago

3.4.0

4 years ago

3.2.1

5 years ago

3.2.0

5 years ago

3.1.0

5 years ago

3.0.0

5 years ago

1.0.1

5 years ago

1.4.0

5 years ago

1.0.0

7 years ago