Skip to content

docs(web): README improvements #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2024
Merged

docs(web): README improvements #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/dynamic-grid-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ The `mrd-dynamic-grid` component is a web component built with LitElement that a

## Installation

To use the `MrdDynamicGridElement` component, you can install it via npm:
To use the `mrd-dynamic-grid` component, you can install it via npm:

```bash
npm install @mordech/dynamic-grid-core @mordech/dynamic-grid-element
npm install @mordech/dynamic-grid-web
```

## Usage

To use the `MrdDynamicGridElement` component, you can import it and use it like any other web component:
To use the `mrd-dynamic-grid` component, you can import it and use it like any other web component:

```html
<!doctype html>
Expand Down Expand Up @@ -40,7 +40,7 @@ To use the `MrdDynamicGridElement` component, you can import it and use it like

## Attributes

The `MrdDynamicGridElement` component accepts the following attributes:
The `mrd-dynamic-grid` component accepts the following attributes:

- `minColumnWidth` (required): The minimum width of each column. This can be any valid CSS length value in `rem` or `px`, such as `200px` or `10rem`.
- `gridType` (optional): The type of grid to use. This can be either `auto-fill` or `auto-fit`. Defaults to `auto-fill`.
Expand Down
Loading