-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| | Name | Type | Required | Description | | ||
| | ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | body | string | true | The contents of the panel. This can contain HTML. | | ||
| | title | string | false | The title for the error summary panel | | ||
| | headingLevel | int | false | Number used to determine the heading level of the title. Use to ensure the title has a correct semantic order on the page. Defaults to `2` | | ||
| | type | string | false | A single value to adjust the component using available variants: “success”, “warn”, “ghost”, “bare”, “error”, “branded”, “warn-branded”, and “announcement” | | ||
| | spacious | boolean | false | Set to “true” to double the padding spacing surrounding the body content if required | | ||
| | classes | string | false | Custom classes to add to the panel | | ||
| | id | string | false | The HTML `id` for the panel | | ||
| | attributes | object | false | HTML attributes to apply to the panel (for example, data attributes) | | ||
| | assistiveTextPrefix | string | false | Sets the visually hidden prefix text for screen readers. Default values for each panel type: <ul><li>`information` and `branded` – “Important information: ”</li><li>`success` – “Completed: ”</li><li>`warn` and `warn-branded` – “Warning: ”</li><li>`error`– “Error: ”</li> | | ||
| | iconType | string | false | Adds an icon to the panel, before the body content, by setting the [icon type](/foundations/icons#icon-type) | | ||
| | iconSize | string | false | Icon size can be set to match the size of the body content text as detailed in the [typography type scale](/foundations/typography/#type-scale) | | ||
| | Name | Type | Required | Description | | ||
| | ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | body | string | true | The contents of the panel. This can contain HTML. | | ||
| | title | string | false | The title for the error summary panel (not supported for the warn, warn-branded, announcement and bare panels ) | | ||
| | headingLevel | int | false | Number used to determine the heading level of the title. Use to ensure the title has a correct semantic order on the page. Defaults to `2` | | ||
| | variant | string | false | A single value to adjust the component using available variants: "info", “success”, “bare”, “error”, “warn”, “warn-branded”, and “announcement” | | ||
| | spacious | boolean | false | Set to “true” to double the padding spacing surrounding the body content if required | | ||
| | classes | string | false | Custom classes to add to the panel | | ||
| | id | string | false | The HTML `id` for the panel | | ||
| | attributes | object | false | HTML attributes to apply to the panel (for example, data attributes) | | ||
| | assistiveTextPrefix | string | false | Sets the visually hidden prefix text for screen readers. Default values for each panel type: <ul><li>`info` – “Important information: ”</li><li>`success` – “Completed: ”</li><li>`warn` and `warn-branded` – “Warning: ”</li><li>`error`– “Error: ”</li><li>`announcement`– “Announcement: ”</li></ul> | | ||
| | iconType | string | false | Adds an icon to the panel, before the body content, by setting the [icon type](/foundations/icons#icon-type) | | ||
| | iconSize | string | false | Icon size can be set to match the size of the body content text as detailed in the [typography type scale](/foundations/typography/#type-scale) | |