Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nc docs/calendar #7998

Merged
merged 5 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/noco-docs/docs/090.views/010.views-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ View represents data from a table. Any updates to records in a view will be refl
2. [Form View](view-types/form)
3. [Gallery View](view-types/gallery)
4. [Kanban View](view-types/kanban)
5. [Calendar View](view-types/calendar)


## View Permission Types
Expand Down
5 changes: 3 additions & 2 deletions packages/noco-docs/docs/090.views/020.create-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ keywords: ['NocoDB view', 'create view']

## Create new view

1. Click on `+` on the left sidebar next to `table name` OR click on `+ New View` button below `table name`.
1. Click on `+ New View` button below `table name`.
2. Select view type from the dropdown modal.
3. Fill view name in the pop-up modal.
- For Kanban view, select the `Single select` field to be used as the Kanban field.
- For Calendar view, select the `Date` OR `DateTime` field to be used as the Calendar field.
Comment on lines +10 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions for creating new views, including Kanban and Calendar views, are clear and concise. However, there's a minor grammatical issue and a suggestion for clarity:

  • Consider changing "Fill view name" to "Enter the view name" for clarity.
  • For consistency with other documentation and general readability, consider using "or" in lowercase within the phrase "Date OR DateTime field".
3. Enter the view name in the pop-up modal.
   - For Kanban view, select the `Single select` field to be used as the Kanban field.
-  - For Calendar view, select the `Date` OR `DateTime` field to be used as the Calendar field.
+  - For Calendar view, select the `Date` or `DateTime` field to be used as the Calendar field.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
1. Click on `+ New View` button below `table name`.
2. Select view type from the dropdown modal.
3. Fill view name in the pop-up modal.
- For Kanban view, select the `Single select` field to be used as the Kanban field.
- For Calendar view, select the `Date` OR `DateTime` field to be used as the Calendar field.
1. Click on `+ New View` button below `table name`.
2. Select view type from the dropdown modal.
3. Enter the view name in the pop-up modal.
- For Kanban view, select the `Single select` field to be used as the Kanban field.
- For Calendar view, select the `Date` or `DateTime` field to be used as the Calendar field.

4. Click on `Create View` button.

![image](/img/v2/views/create-view-1.png)
![image](/img/v2/views/create-view-2.png)

### Related articles


71 changes: 71 additions & 0 deletions packages/noco-docs/docs/090.views/040.view-types/050.calendar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: 'Calendar'
description: 'Learn how to work with Calendar view in NocoDB.'
tags: ['Views', 'Calendar']
keywords: ['NocoDB Calendar', 'Calendar View', 'Calendar board', 'Calendar view operations']
---

Calendar View allows you to visualise your data in a calendar format. You can easily rearrange the records by dragging and dropping them to different dates. You can also visualise the records in a day, week, month, or year format. This section will cover all the operations that can be performed on the Calendar view.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The introduction to the Calendar View feature is well-written and informative. However, consider using "visualize" instead of "visualise" to maintain consistency with American English spelling used in the rest of the documentation.

- Calendar View allows you to visualise your data in a calendar format.
+ Calendar View allows you to visualize your data in a calendar format.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Calendar View allows you to visualise your data in a calendar format. You can easily rearrange the records by dragging and dropping them to different dates. You can also visualise the records in a day, week, month, or year format. This section will cover all the operations that can be performed on the Calendar view.
Calendar View allows you to visualize your data in a calendar format. You can easily rearrange the records by dragging and dropping them to different dates. You can also visualise the records in a day, week, month, or year format. This section will cover all the operations that can be performed on the Calendar view.


![1010-2 Calendar](/img/v2/views/calendar/markers.png)

## Calendar View Actions
1. [Create a New Calendar View](/views/create-view/#create-new-view)
2. [Rename an Existing Calendar View](/views/actions-on-view#rename-view)
3. [Duplicate a Calendar View](/views/actions-on-view#duplicate-view)
4. [Remove a Calendar View](/views/actions-on-view#delete-view)
5. [Share a Calendar View](/views/share-view)
6. [Lock Calendar View for Edits](/views/views-overview#view-permission-types)


## Timescales
For Calendar view, NocoDB supports 4 different timescales:

### Day
In day view, you can see the records for a single day. For records with DateTime fields, you can drag and drop the records to different timeslots within the day.

![day-view](/img/v2/views/calendar/day-scale.png)

### Week
In week view, you can see the records for a single week. You can drag and drop the records to different days within the week. For records with DateTime fields, you can drag and drop the records to different timeslots within the day.

![week-view](/img/v2/views/calendar/week-scale.png)

### Month
In month view, you can see the records for an entire month. You can drag and drop the records to different days within the month.

![month-view](/img/v2/views/calendar/month-scale.png)

### Year
Year view allows you to see a birds-eye view of the records for the entire year. Blue badge on the date indicates that there are records on that date. You can click on the date to see the records for that date.
Comment on lines +39 to +40
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description of the Year view is clear, but there's a minor grammatical suggestion to improve clarity:

  • Consider changing "birds-eye view" to "bird's-eye view" for grammatical correctness.
- Year view allows you to see a birds-eye view of the records for the entire year.
+ Year view allows you to see a bird's-eye view of the records for the entire year.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
### Year
Year view allows you to see a birds-eye view of the records for the entire year. Blue badge on the date indicates that there are records on that date. You can click on the date to see the records for that date.
### Year
Year view allows you to see a bird's-eye view of the records for the entire year. Blue badge on the date indicates that there are records on that date. You can click on the date to see the records for that date.


![year-view](/img/v2/views/calendar/year-scale.png)

## Calendar View Operations

### Customize Record Label
You can customize the record label that appears on the calendar. To do this, click on the `Fields` menu on the toolbar. In the dropdown that appears
- Use toggle to enable or disable the fields that you want to display on the calendar.
- Use reorder to change the order of the fields that you want to display on the calendar.
- Use format menu options to customize the display of the fields on the calendar. You can choose to format the field as Bold, Italicise or Underline.
Comment on lines +47 to +50
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions for customizing the record label are clear and detailed. However, there's a minor spelling inconsistency:

  • Consider using "Italicize" instead of "Italicise" to maintain consistency with American English spelling.
- You can choose to format the field as Bold, Italicise or Underline.
+ You can choose to format the field as Bold, Italicize or Underline.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
You can customize the record label that appears on the calendar. To do this, click on the `Fields` menu on the toolbar. In the dropdown that appears
- Use toggle to enable or disable the fields that you want to display on the calendar.
- Use reorder to change the order of the fields that you want to display on the calendar.
- Use format menu options to customize the display of the fields on the calendar. You can choose to format the field as Bold, Italicise or Underline.
You can customize the record label that appears on the calendar. To do this, click on the `Fields` menu on the toolbar. In the dropdown that appears
- Use toggle to enable or disable the fields that you want to display on the calendar.
- Use reorder to change the order of the fields that you want to display on the calendar.
- Use format menu options to customize the display of the fields on the calendar. You can choose to format the field as Bold, Italicize or Underline.


![fields-menu](/img/v2/views/calendar/fields-menu.png)

### Add New Records
To add a new record to the calendar, click on the `+` icon to the bottom right of the calendar. Alternatively, you can also double-click on the white space in the calendar to add a new record. In the form that appears, fill in the details and click on `Save`.

### Expand Record Details
To view the details of a record, click on the record. This will expand the record and show all the details of the record.

### Edit Record Details
Use drag and drop to move the record to a different date or time. To edit any other details of a record, click on the record to expand it. Edit the details of the record. Make the necessary changes and click on `Save`.

### Delete Record
To delete a record, click on the record to expand it. Click on the `Delete` button from the record context menu. Confirm the deletion by clicking on `Delete` in the confirmation dialog.

## Other toolbar operations
1. [Apply Filters to Display Specific Records on the Calendar](/table-operations/filter)
2. [Sort Records on the Calendar by One or More Criteria](/table-operations/sort)
3. [Perform Quick Searches for Specific Data Within Fields](/table-operations/search)
4. [Export Data to CSV or Excel Format](/table-operations/download#download-data)

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/noco-docs/static/img/v2/views/create-view-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.