Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yagizhanNY committed Jul 5, 2023
1 parent cfaf0c8 commit d5a1d4b
Showing 1 changed file with 118 additions and 8 deletions.
126 changes: 118 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,36 +42,43 @@ Add required `CSS` and `Javascript` packages into the `index.html` file.

### Supported Components

- [Basic Navigation](#basic-navigation) **(since v0.2.7)**
- [Navigation Menu](#navigation-menu) **(since v0.2.7)**
- [About and Legal](#about-and-legal) **(since v0.2.7)**
- [Settings](#settings) **(since v0.2.7)**
- [Map Navigation](#map-navigation) **(since v0.2.7)**
- [Popover News](#popover-news) **(since v0.2.7)**
- [Basic Navigation](#basic-navigation)
- [Navigation Menu](#navigation-menu)
- [About and Legal](#about-and-legal)
- [Settings](#settings)
- [Map Navigation](#map-navigation)
- [Popover News](#popover-news)
- [Blind](#blind)
- [Breadcrumb](#breadcrumb)
- [Button](#button)
- [Card List](#card-list) **(since v0.3.3)**
- [Push Card](#push-card) **(since v0.3.3)**
- [Action Card](#action-card) **(since v0.3.3)**
- [Icon Button](#icon-button)
- [Category Filter](#category-filter)
- [ECharts](#echarts) **(since v0.3.2)**
- [Checkbox](#checkbox)
- [Chip](#chip)
- [Content Header](#content-header) **(since v0.3.3)**
- [Date Picker](#date-picker)
- [Date Time Picker](#date-time-picker)
- [Divider](#divider)
- [Drawer](#drawer)
- [Dropdown Button](#dropdown-button)
- [Dropdown](#dropdown)
- [Empty State](#empty-state) **(since v0.3.3)**
- [Event List](#event-list)
- [Expanding Search](#expanding-search)
- [Flip](#flip)
- [Group](#group)
- [HTML Table](#html-table)
- [Input](#input)
- [Key Value List](#key-value-list) **(since v0.3.3)**
- [Key Value](#key-value) **(since v0.3.3)**
- [KPI](#kpi)
- [Message Bar](#message-bar)
- [Modal](#modal)
- [Pagination](#pagination) **(since v0.2.6)**
- [Pagination](#pagination)
- [Pill](#pill)
- [Radio Button](#radio-button)
- [Select](#select)
Expand All @@ -84,7 +91,7 @@ Add required `CSS` and `Javascript` packages into the `index.html` file.
- [Toast](#toast)
- [Toggle](#toggle)
- [Tooltip](#tooltip)
- [Tree](#tree) **(since v0.2.9)**
- [Tree](#tree)
- [Upload](#upload)
- [Form Validation](#form-validation)
- [Workflow](#workflow)
Expand Down Expand Up @@ -237,6 +244,50 @@ Test content
<Button>Test Button</Button>
```

## Card List

```html
<CardList Id="carlist1" Label="Stack Layout" ShowAllCount="12" ListStyle="Enums.CardList.CardListStyle.Stack" CollapseChangedEvent="CardListCollapsedChanged"
ShowAllClickEvent="CardListShowAllClicked" ShowMoreCardClickEvent="CardListShowMoreClicked">
<PushCard Icon="rocket"
Notification="3"
Heading="Heading content"
SubHeading="Subheading"
Variant="PushCardVariant.Notification"></PushCard>
<PushCard Icon="bulb"
Notification="1"
Heading="Heading content"
SubHeading="Subheading"
Variant="PushCardVariant.Warning"></PushCard>
<PushCard Icon="rocket"
Notification="3"
Heading="Heading content"
SubHeading="Subheading"
Variant="PushCardVariant.Success"></PushCard>
</CardList>
```

## Push Card

```html
<PushCard Icon="rocket"
Notification="3"
Heading="Heading content"
SubHeading="Subheading"
Variant="PushCardVariant.Notification"></PushCard>
```

## Action Card

```html
<ActionCard
Icon="refresh"
Heading="Scan for new devices"
SubHeading="Secondary text"
Variant="PushCardVariant.Notification"
></ActionCard>
```

## Icon Button

```html
Expand Down Expand Up @@ -407,6 +458,17 @@ chart1.InitialChart(object1);
</Chip>
```

## Content Header

```html
<ContentHeader Id="content-header-1" HasBackButton="true"
HeaderTitle="Content title"
HeaderSubTitle="Subtitle"
BackButtonClickedEvent="ContentHeaderBackButtonClicked">
Test
</ContentHeader>
```

## Date picker

```html
Expand Down Expand Up @@ -484,6 +546,17 @@ private void DrawerButtonClicked()
</Dropdown>
```

## Empty State

```html
<EmptyState
Header="No elements available"
SubHeader="Create an element first"
Icon="add"
Action="Create element"
></EmptyState>
```

## Event list

```html
Expand Down Expand Up @@ -578,6 +651,43 @@ private void DrawerButtonClicked()
</form>
```

## Key Value List

```html
<KeyValueList>
<KeyValue
Label="Label"
LabelPosition="left"
Value="Value"
></KeyValue>

<KeyValue
Label="Label"
LabelPosition="left"
Value="Value"
></KeyValue>

<KeyValue
Label="Label"
LabelPosition="left"
Value="Value"
></KeyValue>
</KeyValueList>
```

## Key Value

```html
<KeyValue Label="Label">
<input
class="form-control"
placeholder="Enter text here"
type="text"
slot="custom-value"
/>
</KeyValue>
```

## KPI

```html
Expand Down

0 comments on commit d5a1d4b

Please sign in to comment.