IlyaSobolev/DocSpace-buildtools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Web: Components: CampaignsBanner - added description

Browse Source
This commit is contained in:
DmitrySychugov 2023-04-17 18:25:16 +05:00
parent 39f0a7b2c0
commit 6852d0eaa7
2 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
packages/components/campaigns-banner/README.md
View File

@ -14,13 +14,13 @@ import CampaignsBanner from "@docspace/components/campaigns-banner";
### Properties
| Props | Type | Required | Values | Default | Description |
| ------------- | :------------: | :------: | :----: | :-----: | ----------------- |
| `headerLabel` | `string` | ✅ | - | - | |
| `textLabel` | `string` | ✅ | - | - | |
| `img` | `string` | ✅ | - | - | |
| `buttonLabel` | `string` | ✅ | - | - | |
| `btnLink` | `string` | ✅ | - | - | |
| `className` | `string` | - | - | - | Accepts class |
| `id` | `string` | - | - | - | Accepts id |
| `style` | `obj`, `array` | - | - | - | Accepts css style |
| Props | Type | Required | Values | Default | Description |
| ------------- | :------------: | :------: | :----: | :-----: | ---------------------------------------------- |
| `headerLabel` | `string` | ✅ | - | - | Label subheader |
| `textLabel` | `string` | ✅ | - | - | Label |
| `img` | `string` | ✅ | - | - | Image source |
| `buttonLabel` | `string` | ✅ | - | - | Header button text |
| `link` | `string` | ✅ | - | - | The link that opens when the button is clicked |
| `className` | `string` | - | - | - | Accepts class |
| `id` | `string` | - | - | - | Accepts id |
| `style` | `obj`, `array` | - | - | - | Accepts css style |

5
packages/components/campaigns-banner/index.js
View File

@ -65,10 +65,15 @@ CampaignsBanner.propTypes = {
className: PropTypes.string,
/** Accepts css style */
style: PropTypes.object,
/** Label */
headerLabel: PropTypes.string,
/** Label subheader */
subHeaderLabel: PropTypes.string,
/** Image source */
img: PropTypes.string,
/** Header button text */
buttonLabel: PropTypes.string,
/** The link that opens when the button is clicked */
link: PropTypes.string,
};