Skip to content

Commit

Permalink
docs: Update DatePicker props documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
franmc01 authored Oct 7, 2023
1 parent 153c87b commit dedb21b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs-site/src/components/Examples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,15 @@ export default class exampleComponents extends React.Component {
component: Default,
},
{
title: "Calendar Icon Default",
title: "Calendar Icon",
component: CalendarIcon,
},
{
title: "Calendar Icon React Svg Component",
title: "Calendar Icon using React Svg Component",
component: CalendarIconSvgIcon,
},
{
title: "Calendar Icon External Lib",
title: "Calendar Icon using External Lib",
component: CalendarIconExternal,
},
{
Expand Down
7 changes: 5 additions & 2 deletions docs/datepicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ General datepicker component.
| `injectTimes` | `array` | | |
| `inline` | `bool` | | |
| `isClearable` | `bool` | | |
| `showIcon` | `bool` | | |
| `locale` | `string` | | |
| `maxDate` | `instanceOf(Date)` | | |
| `maxTime` | `instanceOf(Date)` | | |
Expand All @@ -69,7 +68,8 @@ General datepicker component.
| `peekNextMonth` | `bool` | | |
| `placeholderText` | `string` | | |
| `popperClassName` | `string` | | |
| `popperContainer` | `func` | | |
| `popperContainer` | `func` | |
| |
| `popperModifiers` | `object` | | |
| `popperPlacement` | `enumpopperPlacementPositions` | | |
| `preventOpenOnFocus` | `bool` | false | When this is true, the datepicker will not automatically open when the date field is focussed |
Expand Down Expand Up @@ -103,3 +103,6 @@ General datepicker component.
| |
| `yearItemNumber` | `number` | `12` | |
| `yearDropdownItemNumber` | `number` | | |
| `icon` | `string` or `element` | | Allows using a custom calendar icon. Accepts a string (icon class name) or a React component (e.g., custom SVG). If a string is passed, an `<i>` element is rendered with that string as its class name. If a React component is passed, it is rendered as-is. |
| `calendarIconClassName` | `string` | | Accepts a string that will be added as an additional CSS class to the calendar icon, allowing further styling customization. |
| `showIcon` | `bool` | `true` | Determines whether the calendar icon is displayed. Set to `true` to display the icon, and `false` to hide it. If `icon` prop is also provided, the custom icon will be displayed when `showIcon` is `true`. |

0 comments on commit dedb21b

Please sign in to comment.