Skip to content

Commit

Permalink
Docs(web, web-twig): Unify column names in API tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamkudrna @literat
adamkudrna authored and literat committed Aug 23, 2023
1 parent 7861c18 commit b33b8ff
Show file tree
Hide file tree
Showing 32 changed files with 63 additions and 63 deletions.
8 changes: 4 additions & 4 deletions packages/web-twig/src/Resources/components/Accordion/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,21 +183,21 @@ The Accordion itself consists of several components which cannot be used indepen

### Accordion

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | --------- | -------- | ------------------------------------------------------------------------------------------------- |
| `elementType` | `string` | `section` | ✕ | Custom element type |
| `id` | `string` | `null` | optional | It depends on whether the "Stay open" functionality is used. If so, the id field is not required. |

### AccordionItem

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | --------- | -------- | ------------------- |
| `elementType` | `string` | `article` | ✕ | Custom element type |
| `id` | `string` | `null` | ✔ | AccordionItem ID |

### AccordionHeader

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | ------- | -------- | ------------------------ |
| `elementType` | `string` | `h3` | ✕ | Custom element type |
| `for` | `string` | `null` | ✔ | AccordionContent ID |
Expand All @@ -207,7 +207,7 @@ The Accordion itself consists of several components which cannot be used indepen

### AccordionContent

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| -------------- | -------- | ------- | -------- | --------------------------------------------------------------------------- |
| `id` | `string` | `null` | ✔ | AccordionContent ID |
| `isOpen` | `bool` | `false` | ✕ | If true, make the item open on page load |
Expand Down
2 changes: 1 addition & 1 deletion packages/web-twig/src/Resources/components/Alert/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Without lexer:

## API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------------------------------------------- | --------- | -------- | -------------------------- |
| `color` | [Emotion Color dictionary][dictionary-color] | `success` | ✕ | Color variant |
| `elementType` | `string` | `div` | ✕ | HTML tag to render |
Expand Down
4 changes: 2 additions & 2 deletions packages/web-twig/src/Resources/components/Breadcrumbs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ content can be overridden by any custom block content.

## Breadcrumbs

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `elementType` | `string` | `nav` | ✕ | HTML tag to render |
| `goBackTitle` | `string` | `` | ✕ | Title/translation for back link to previous page on mobile. It's essential to be set along with items. If items property is not passed, backlink is to be created within children property. |
| `goBackTitle` | `string` | — | ✕ | Title/translation for back link to previous page on mobile. It's essential to be set along with items. If items property is not passed, backlink is to be created within children property. |
| `items` | `array` | `[]` | ✕ | Navigation menu items |

You can add `id`, `data-*` or `aria-*` attributes to further extend the component's
Expand Down
2 changes: 1 addition & 1 deletion packages/web-twig/src/Resources/components/Button/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Without lexer:

## API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------ | ----------------------------------------------------------------------------------------- | --------- | -------- | -------------------------------------------------------------------------- |
| `color` | [Action Color dictionary][dictionary-color], [Emotion Color dictionary][dictionary-color] | `primary` | ✕ | Color variant |
| `formtarget` | `string` | `null` | ✕ | Submit button target |
Expand Down
2 changes: 1 addition & 1 deletion packages/web-twig/src/Resources/components/ButtonLink/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Without lexer:

## API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------ | ----------------------------------------------------------------------------------------- | --------- | -------- | ------------------------------------------------------------------------------ |
| `color` | [Action Color dictionary][dictionary-color], [Emotion Color dictionary][dictionary-color] | `primary` | ✕ | Color variant |
| `size` | [Size dictionary][dictionary-size] | `medium` | ✕ | Size variant |
Expand Down
2 changes: 1 addition & 1 deletion packages/web-twig/src/Resources/components/Checkbox/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Without lexer:

## API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ----------------------- | ---------------------------------------------- | ------- | -------- | ---------------------------------------------------- |
| `autocomplete` | `string` | `null` | ✕ | [Automated assistance in filling][autocomplete-attr] |
| `helperText` | `string` | `null` | ✕\*\* | Custom helper text |
Expand Down
4 changes: 2 additions & 2 deletions packages/web-twig/src/Resources/components/Collapse/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ attributes to register trigger events.

## API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | ------- | -------- | ---------------------------------------------------------------------- |
| `breakpoint` | `string` | `null` | ✕ | Breakpoint level [mobile,tablet,desktop] |
| `elementType` | `string` | `div` | ✕ | Custom element type for wrapper and content |
Expand All @@ -69,7 +69,7 @@ see the [Escape hatches][escape-hatches] section in README to learn how and when

## Trigger attributes

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| -------------------- | -------- | ---------- | -------- | ----------------------------------- |
| `aria-controls` | `string` | — | ✕ | Aria controls state (auto) |
| `aria-expanded` | `string` | — | ✕ | Aria expanded state (auto) |
Expand Down
6 changes: 3 additions & 3 deletions packages/web-twig/src/Resources/components/Dropdown/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ attributes to register trigger events.

### Dropdown

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| --------------- | -------------------------------------------------------------- | ------------- | -------- | ------------------------------------- |
| `elementType` | `string` | `div` | ✕ | HTML tag to render |
| `fullWidthMode` | `string` | — | ✕ | Full-width mode [off,mobile-only,all] |
Expand All @@ -67,7 +67,7 @@ see the [Escape hatches][escape-hatches] section in README to learn how and when

### Trigger attributes

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| -------------------- | -------- | ---------- | -------- | -------------------------- |
| `aria-controls` | `string` | — | ✕ | Aria controls state (auto) |
| `aria-expanded` | `string` | — | ✕ | Aria expanded state (auto) |
Expand All @@ -79,7 +79,7 @@ or the width of the window is changed. There can be several triggers, the same r

### DropdownWrapper

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | ------- | -------- | ------------------ |
| `elementType` | `string` | `div` | ✕ | HTML tag to render |

Expand Down
2 changes: 1 addition & 1 deletion packages/web-twig/src/Resources/components/FieldGroup/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ When validated on server:

## API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ----------------------- | ---------------------------------------------- | ------- | -------- | ------------------------------------------ |
| `form` | `string` | `null` | ✕ | Parent form ID |
| `helperText` | `string` | `null` | ✕\*\* | Custom helper text |
Expand Down
6 changes: 3 additions & 3 deletions packages/web-twig/src/Resources/components/FileUploader/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ By adding the `isFluid` attribute, FileUploader can take up all the available ho

### API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| --------- | ------ | ------- | -------- | ---------------------------------------------------------- |
| `isFluid` | `bool` | `false` | ✕ | If true, the element spans to the full width of its parent |

Expand Down Expand Up @@ -181,7 +181,7 @@ To mark the input as disabled, simply add the `isDisabled` attribute:

### API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ----------------------- | ---------------------------------------------- | ----------------------- | -------- | --------------------------------------------------------------------- |
| `accept` | `string` | `null` | ✕ | Allowed file types |
| `dragAndDropText` | `string` | `or drag and drop here` | ✕ | Text shown in the drop zone if drag-and-drop is enabled on the device |
Expand Down Expand Up @@ -226,7 +226,7 @@ FileUploaderList is a simple wrapper which provides an accessible title and the

### API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | -------- | --------------------------- | -------- | ------------------------------- |
| `headingId` | `string` | `file-uploader-attachments` | ✕ | List and heading identification |
| `headingText` | `string` | `Attachments` | ✕ | List title |
Expand Down
4 changes: 2 additions & 2 deletions packages/web-twig/src/Resources/components/Grid/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Without lexer:

### API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | ------------------------------------------------ | ------- | -------- | ----------------------------------- |
| `cols` | [`1` \| `2` \| `3` \| `4` \| `5` \| `6` \| `12`] | `null` | ✕ | Number of columns to use |
| `tablet` | [`1` \| `2` \| `3` \| `4` \| `5` \| `6` \| `12`] | `null` | ✕ | Number of columns to use on tablet |
Expand Down Expand Up @@ -102,7 +102,7 @@ Without lexer:

### API

| Prop name | Type | Default | Required | Description |
| Name | Type | Default | Required | Description |
| ------------- | ------------------------------------------ | ------- | -------- | ----------------------------------------- |
| `over` | [`2` \| `4` \| `6` \| `8` \| `10` \| `12`] | `null` | ✕ | Number of columns to span over |
| `tablet` | [`2` \| `4` \| `6` \| `8` \| `10` \| `12`] | `null` | ✕ | Number of columns to span over on tablet |
Expand Down
Loading

0 comments on commit b33b8ff

Please sign in to comment.