# amwal-installments-timeline



<!-- Auto Generated Below -->


## Properties

| Property                 | Attribute                  | Description                                                                                  | Type                    | Default     |
| ------------------------ | -------------------------- | -------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
| `amount`                 | `amount`                   | The total amount to be paid in installments                                                  | `number`                | `0`         |
| `border`                 | `border`                   | Enable or disable border around the timeline                                                 | `boolean`               | `false`     |
| `debug`                  | `debug`                    | Enable debug mode for additional console logs                                                | `boolean`               | `false`     |
| `decimalPlaces`          | `decimal-places`           | Number of decimal places for amount formatting                                               | `number`                | `2`         |
| `enableInstallments`     | `enable-installments`      | Enable or disable installments feature                                                       | `boolean`               | `false`     |
| `footerMessage`          | `footer-message`           | Footer message for simple timeline style                                                     | `string`                | `undefined` |
| `installmentData`        | `installment-data`         | The installment payments (optional - will be calculated if not provided)                     | `string`                | `'[]'`      |
| `installmentsCount`      | `installments-count`       | Number of installments                                                                       | `number`                | `6`         |
| `intervalMonths`         | `interval-months`          |                                                                                              | `number`                | `1`         |
| `labelFormat`            | `label-format`             |                                                                                              | `"date" \| "simple"`    | `'simple'`  |
| `locale`                 | `locale`                   | the language of the plugin. supported languages are Arabic ("ar") and English ("en")         | `string`                | `"en"`      |
| `maxVisibleInstallments` | `max-visible-installments` | Maximum number of installments to display (for UI clarity)                                   | `number`                | `3`         |
| `startDate`              | `start-date`               |                                                                                              | `string`                | `undefined` |
| `timelineStyle`          | `timeline-style`           | Timeline display style: 'default' for circular timeline, 'simple' for modern dots with lines | `"default" \| "simple"` | `'default'` |


## Dependencies

### Used by

 - [amwal-checkout-button](../amwal-checkout-button)
 - [amwal-installments-guide](../amwal-installments-guide)

### Graph
```mermaid
graph TD;
  amwal-checkout-button --> amwal-installments-timeline
  amwal-installments-guide --> amwal-installments-timeline
  style amwal-installments-timeline fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*