# calendar
A Reflex custom component calendar wrapping the [react-calendar](https://www.npmjs.com/package/react-calendar) component.
## Installation
```bash
pip install reflex-calendar
```
## Usage
```python
from reflex_calendar import calendar
def index():
return calendar()
```
### Props:
- `go_to_range_start_on_select`: Go to the start of the range when selecting a range.
- `value`: The date value.
- `locale`: The locale.
- `min_date`: The minimum date.
- `max_date`: The maximum date.
- `min_detail`: The minimum detail.
- `max_detail`: The maximum detail.
- `navigation_label`: The navigation label.
- `next2_label`: The next2 label.
- `next_label`: The next label.
- `prev2_label`: The prev2 label.
- `prev_label`: The prev label.
- `select_range`: The select range.
- `show_double_view`: Show double view.
- `show_fixed_number_of_weeks`: Show fixed number of weeks.
- `show_navigation`: Show navigation.
- `show_neighboring_month`: Show neighboring month.
- `show_neighboring_century`: Show neighboring century.
- `show_neighboring_decade`: Show neighboring decade.
- `show_week_numbers`: Show week numbers.
### Event triggers:
- `on_change`: Triggered when the date is changed. (return the date)
- `on_click_day`: Triggered when a day is clicked. (return the full date)
- `on_click_month`: Triggered when a month is clicked. (return a date at start/end of the month)
- `on_click_year`: Triggered when a year is clicked. (return a date at start/end of the year)
- `on_click_decade`: Triggered when a decade is clicked. (return a date at start/end of the decade)
- `on_click_week_number`: Triggered when a week number is clicked. (return a date at start/end of the week)
- `on_drill_down`: Triggered when the calendar is drilled down. (return the event)
- `on_drill_up`: Triggered when the calendar is drilled up. (return the event)
- `on_view_change`: Triggered when the view is changed. (return the event)
When returning an event, it's a dictionary with the following keys:
- `action`: The action.
- `activeStartDate`: The start date in the resulting view.
- `value`: The value.
- `view`: The view where the event happened.
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-calendar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "reflex, reflex-custom-components",
"author": null,
"author_email": "Thomas Brand\u00e9ho <thomas.brandeho@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bf/76/7635e6e5a79c38ad7308fa83e86b703cd2b986f340b7aaa81b8932f97278/reflex_calendar-0.0.5.tar.gz",
"platform": null,
"description": "# calendar\n\nA Reflex custom component calendar wrapping the [react-calendar](https://www.npmjs.com/package/react-calendar) component.\n\n## Installation\n\n```bash\npip install reflex-calendar\n```\n\n## Usage\n\n```python\nfrom reflex_calendar import calendar\n\ndef index():\n return calendar()\n```\n\n### Props:\n- `go_to_range_start_on_select`: Go to the start of the range when selecting a range.\n- `value`: The date value.\n- `locale`: The locale.\n- `min_date`: The minimum date.\n- `max_date`: The maximum date.\n- `min_detail`: The minimum detail.\n- `max_detail`: The maximum detail.\n- `navigation_label`: The navigation label.\n- `next2_label`: The next2 label.\n- `next_label`: The next label.\n- `prev2_label`: The prev2 label.\n- `prev_label`: The prev label.\n- `select_range`: The select range.\n- `show_double_view`: Show double view.\n- `show_fixed_number_of_weeks`: Show fixed number of weeks.\n- `show_navigation`: Show navigation.\n- `show_neighboring_month`: Show neighboring month.\n- `show_neighboring_century`: Show neighboring century.\n- `show_neighboring_decade`: Show neighboring decade.\n- `show_week_numbers`: Show week numbers.\n\n### Event triggers:\n\n- `on_change`: Triggered when the date is changed. (return the date)\n- `on_click_day`: Triggered when a day is clicked. (return the full date)\n- `on_click_month`: Triggered when a month is clicked. (return a date at start/end of the month)\n- `on_click_year`: Triggered when a year is clicked. (return a date at start/end of the year)\n- `on_click_decade`: Triggered when a decade is clicked. (return a date at start/end of the decade)\n- `on_click_week_number`: Triggered when a week number is clicked. (return a date at start/end of the week)\n- `on_drill_down`: Triggered when the calendar is drilled down. (return the event)\n- `on_drill_up`: Triggered when the calendar is drilled up. (return the event)\n- `on_view_change`: Triggered when the view is changed. (return the event)\n\nWhen returning an event, it's a dictionary with the following keys:\n- `action`: The action.\n- `activeStartDate`: The start date in the resulting view.\n- `value`: The value.\n- `view`: The view where the event happened.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Reflex custom component calendar",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/Lendemor/reflex-calendar"
},
"split_keywords": [
"reflex",
" reflex-custom-components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9da626d11dbcdfbd4f924cde7ee487aee98c2953bdef0a75c92f8e28632360e6",
"md5": "7aa532a4decd9bb2a3d78315fae77892",
"sha256": "2d4adf25d3703594f39fe7de8662ea3850cf43bcb80bd3e84f5d6af28dd33b16"
},
"downloads": -1,
"filename": "reflex_calendar-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7aa532a4decd9bb2a3d78315fae77892",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5966,
"upload_time": "2024-11-18T16:00:36",
"upload_time_iso_8601": "2024-11-18T16:00:36.776115Z",
"url": "https://files.pythonhosted.org/packages/9d/a6/26d11dbcdfbd4f924cde7ee487aee98c2953bdef0a75c92f8e28632360e6/reflex_calendar-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf767635e6e5a79c38ad7308fa83e86b703cd2b986f340b7aaa81b8932f97278",
"md5": "7bce4736f41355ca2ac7d0c91b286eec",
"sha256": "39beb768b4fd261c4463f930d8a49a54366f91de42c85843232b7c6c850a762b"
},
"downloads": -1,
"filename": "reflex_calendar-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "7bce4736f41355ca2ac7d0c91b286eec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5512,
"upload_time": "2024-11-18T16:00:37",
"upload_time_iso_8601": "2024-11-18T16:00:37.760814Z",
"url": "https://files.pythonhosted.org/packages/bf/76/7635e6e5a79c38ad7308fa83e86b703cd2b986f340b7aaa81b8932f97278/reflex_calendar-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 16:00:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Lendemor",
"github_project": "reflex-calendar",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "reflex-calendar"
}
JSON
