lang: en-US title: Attributes

For more informations please visit: docs page

Attributes

Properties

1. Required properties

| Property | Type | Description | | -------- | -------| ----------- | | amount | number | You have to set initial value how many money you want to send to beneficiary. Will be paid on the end of month period, so there is enough time to change it id you will need. Can be changed manually on account page or by request. | | duration-in-months | number | You have to set initial value for how many monthly periods you want to be subscribed to pay to beneficiary. You can change it later, but minimum number has to be higher than number of months that left or is in progress. Have to be at least 1. Can be changed manually on account page or by request. |

2. General appearance

| Property | Type | Default value | Description | | ------------------- | ------ | ------------- | ----------- | | label | string | - | Text on the top of component that can be an explanation whcomponent is usefull. Label is created only if its value exist. | | profit-expiration-text | string | - | Text information about beneficiary profit expiration. Use this property if you have selected in setting in your Commission Forge account that you want to remove beneficiaries which are not confirmed for longer time than value in settings. You don't need to write how long time is for expirarttion. Value of time will be added after this text. Example profit text: 'Profit will expire if we won't have chance to confirm recommendation after '. Text from example is default value if you have enabled beneficiary profit expiration in your account settings but value of 'profit-expiration-text' property is missing. | | name-label | string | Name | Usefull if you want change text of name label for example to other language. | | hide-name | boolean | false | Set true to hide name input and label. | | lastname-label | string | Lastname | Usefull if you want change text of lastname label for example to other language. | | hide-lastname | boolean | false | Set true to hide lastname input and label. | | background-color | string | rgb(245, 213, 94) | Background color of whole component | | border-color | string | rgb(229, 42, 29) | Color of border of whole component | | labels-text-size | string | 1rem | font size of all labels of inputs | | labels-text-color | string | rgb(229 42 29) | Color of all labels of inputs |

3. Submit button appearance

| Property | Type | Default value | Description | | ------------------------ | ------ | ------------- | ----------- | | submit-button-text | string | - | Text of submit button of component that will store data of beneficiary. Button is not required and is created only if its text exist. | | submit-button-height | string | 2.75rem | Height of submit button of component that will store data of beneficiary. | | submit-button-width | string | 2.75rem | Width of submit button of component that will store data of beneficiary. | | submit-button-padding | string | 1rem | Inline padding of submit button of component that will store data of beneficiary. | | submit-button-text-color | string | white | Color of text of submit button of component that will store data of beneficiary. | | submit-button-text-size | string | 1rem | Font size of submit button of component that will store data of beneficiary. | | submit-button-background | string | rgb(247 59 103) | Background color of submit button of component that will store data of beneficiary. | | submit-button-border | string | none | Border property of submit button of component that will store data of beneficiary. | | submit-button-radius | string | 0.375rem | Border radius of submit button of component that will store data of beneficiary. |

Methods

| Name | Arguments | Return | Description | | --------------------------------- | ------------------------------ | ------ | ----------- | | initAndRegisterComponent(options) | options: { apiKey } - required | - | You have to use this function to provide API key. Without API key component will not be able to do any proper request | | storeBeneficiary(selector = null) | selector: string - optional | Promise | You can use this function to store beneficiary data without using submit button built in component (for example if component is a part of existing form in your html and you have already own button). Argument selector can be used in case you have more than one use of commission-forge component in your html and need to store data form selected one |