Browse Source

docs: views update

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
197005303f
  1. 39
      packages/noco-docs/docs/080.views/010.overview.md
  2. 20
      packages/noco-docs/docs/080.views/020.create-view.md
  3. 3
      packages/noco-docs/docs/080.views/020.create.md
  4. 45
      packages/noco-docs/docs/080.views/025.share-view.md
  5. 3
      packages/noco-docs/docs/080.views/050.delete-view.md
  6. 3
      packages/noco-docs/docs/080.views/060.configurations.md
  7. 47
      packages/noco-docs/docs/080.views/090.actions-on-view.md
  8. 4
      packages/noco-docs/docs/080.views/090.view-types/010.grid.md
  9. 4
      packages/noco-docs/docs/080.views/090.view-types/020.gallery.md
  10. 4
      packages/noco-docs/docs/080.views/090.view-types/030.forms.md
  11. 4
      packages/noco-docs/docs/080.views/090.view-types/040.kanban.md
  12. BIN
      packages/noco-docs/static/img/v2/views/create-view-1.png
  13. BIN
      packages/noco-docs/static/img/v2/views/create-view-2.png
  14. BIN
      packages/noco-docs/static/img/v2/views/delete-view-confirmation.png
  15. BIN
      packages/noco-docs/static/img/v2/views/duplicate-confirmation.png
  16. BIN
      packages/noco-docs/static/img/v2/views/locked-view.png
  17. BIN
      packages/noco-docs/static/img/v2/views/share-button.png
  18. BIN
      packages/noco-docs/static/img/v2/views/share-view-1.png
  19. BIN
      packages/noco-docs/static/img/v2/views/share-view-copy-link.png
  20. BIN
      packages/noco-docs/static/img/v2/views/share-view-download.png
  21. BIN
      packages/noco-docs/static/img/v2/views/share-view-password.png
  22. BIN
      packages/noco-docs/static/img/v2/views/view-context-menu.png

39
packages/noco-docs/docs/080.views/010.overview.md

@ -11,47 +11,22 @@ View represents data from a table. Any updates to records in a view will be refl
## View Types ## View Types
### Grid View 1. [Grid View](view-types/grid)
2. [Form View](view-types/form)
3. [Gallery View](view-types/gallery)
4. [Kanban View](view-types/kanban)
Grid View, as a default type of view, allows you to display your data in a spreadsheet-like interface using rows and columns. Rows are as referred to as records and columns as fields in NocoDB.
![1010-2 Grid](/img/content/grid.png)
### Form View
Form View allows you to arrange fields in a form to input data.
![1010-2 Form](/img/content/form.png)
You can drag-drop fields from the form to form-field-menu-bar as required.
### Gallery View
Gallery View allows you to display images as thumbnails with other fields just like a gallery.
![1010-2 Gallery](/img/content/gallery.png)
### Kanban View
Kanban View allows you to visualise your data using cards at various stacks.
![1010-2 Kanban](/img/content/kanban.png)
## View Permission Types ## View Permission Types
We can apply permission to each View. By default, views are `Collaborative`. To see or change the view type, expand `view-tool-bar-menu` as shown below. We can apply permission to each View. By default, views are `Collaborative`. To see or change the view type, expand `view-tool-bar-menu` as shown below.
![locked view](https://github.com/nocodb/nocodb/assets/86527202/41b28e3b-f8c3-46b7-8e9e-894706379a1c) ![locked view](/img/v2/views/locked-view.png)
### Collaborative Views (default) ### Collaborative Views (default)
- Collaborators with edit permissions or higher can change the view configurations By default, views are set to "Collaborative," allowing collaborators with edit permissions or higher to modify view configurations. In this mode, all collaborators can read and write data to the view. This is the default mode for all views.
### Locked Views ### Locked Views
- No one can edit view configurations until it is Unlocked With "Locked Views," no one can edit the view configurations until they are unlocked. In this mode, all collaborators are restricted to reading data from the view and are unable to make any changes to its settings or content. This mode is useful when you want to share a view with others but don't want them to make any changes to it.
- All collaborators can only READ data from such views
### Personal Views
- Only you can edit the view configuration.
- Your personal views are hidden for other collaborators
- Are not available currently; will be enabled in future release

20
packages/noco-docs/docs/080.views/020.create-view.md

@ -0,0 +1,20 @@
---
title: 'Create view'
description: 'Learn how to create a view in NocoDB.'
tags: ['views', 'create view']
keywords: ['NocoDB view', 'create view', 'view administration', 'view organization']
---
## Create new view
1. Click on `+` on the left sidebar next to `table name` OR 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.
4. Click on `Create View` button.
![image](/img/v2/views/create-view-1.png)
![image](/img/v2/views/create-view-2.png)
### Related articles

3
packages/noco-docs/docs/080.views/020.create.md

@ -1,3 +0,0 @@
---
title: 'Create view'
---

45
packages/noco-docs/docs/080.views/025.share-view.md

@ -1,31 +1,52 @@
--- ---
title: "Share View" title: "Share View"
description: "Procedures to share a view" description: "Procedures to share a view"
tags: ["views", "share view", "share"]
keywords: ["NocoDB view", "share view", "share", "share view with password protection", "share view with download options"]
--- ---
Sharing a specific view of a table becomes highly valuable when you need to collaborate with individuals outside your organization who need access to specific sections of your database. This shared view provides a read-only perspective, accessible to anyone, regardless of their workspace affiliation. You have control over which data fields and records are visible to these external viewers, ensuring that any sensitive data remains hidden. Furthermore, if you decide to make changes to the visible fields or records within the view, the shared link will promptly reflect these adjustments, updating in real-time.
## Generate Share View ## Generate Share View
1. Click `Share` button on the top right of the toolbar
- Open a table or a view ![share button](/img/v2/views/share-button.png)
- Click `Share` button on the top right of the toolbar 2. Toggle `Enable public viewing` to create shared view link
![shared view](/img/v2/views/share-view-1.png)
![share button](https://github.com/nocodb/nocodb/assets/86527202/86d7d8c7-9ed8-4429-a9b8-d08c777e9579) 3. Click `Copy` button to copy the link to clipboard
![copy link](/img/v2/views/share-view-copy-link.png)
- Toggle `Enable public viewing` to create shared view link ### Share view options
#### Password protection
You can enable `Restrict access with a password` if you want a password-protected view
![password protection](/img/v2/views/share-view-password.png)
![shared view](https://github.com/nocodb/nocodb/assets/86527202/5af71246-72cc-4516-ba35-590035f73d8e) #### Download options
You can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link
- You can enable `Restrict access with a password` if you want a password-protected view
- Or you can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link ![download options](/img/v2/views/share-view-download.png)
## Access Share View ## Access Share View
To access the shared view, please follow the steps below:
Click on the `Shared View URL`. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed.
![image](https://user-images.githubusercontent.com/35857179/194690379-e3d89df6-d9c1-4d9d-9e8c-7e59c3978d31.png)
- Access the link. If it is password-protected, enter the password to unlock. Once the password is successfully entered and authenticated, you will gain access to the shared view.
In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password.
![image](https://user-images.githubusercontent.com/35857179/194690389-5b78e236-aacc-49c2-898e-110f95edd1e5.png)
![image](https://user-images.githubusercontent.com/35857179/194690379-e3d89df6-d9c1-4d9d-9e8c-7e59c3978d31.png) Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements.
- Otherwise, you should see the share view. :::info
Note that, filters & sorts applied to shared view will not be persisted. These filters & sorts will be reset when the shared view is accessed again.
:::
![image](https://user-images.githubusercontent.com/35857179/194690389-5b78e236-aacc-49c2-898e-110f95edd1e5.png) ## Related articles

3
packages/noco-docs/docs/080.views/050.delete-view.md

@ -1,3 +0,0 @@
---
title: 'Delete view'
---

3
packages/noco-docs/docs/080.views/060.configurations.md

@ -1,3 +0,0 @@
---
title: 'Actions on views'
---

47
packages/noco-docs/docs/080.views/090.actions-on-view.md

@ -0,0 +1,47 @@
---
title: 'Actions on view'
description: 'Learn how to delete, rename, duplicate a a view in NocoDB.'
tags: ['views', 'delete view', 'rename view', 'duplicate view']
keywords: ['NocoDB view', 'delete view', 'rename view', 'duplicate view', 'view administration', 'view organization']
---
## View context menu
The view context menu provides a set of tools to interact with the view. The view context menu can be accessed by clicking on the ellipsis symbol (`...`) located next to view in the left sidebar.
![image](/img/v2/views/view-context-menu.png)
## Rename view
1. Click on the ellipsis symbol (`...`) next to view name located in the left sidebar.
2. Click on the `Rename` option from the view context menu.
3. Enter the desired new view name into the provided field.
4. Use `Enter` key to finalize the renaming process.
![image](/img/v2/views/view-context-menu.png)
## Duplicate view
1. Click on the ellipsis symbol (`...`) next to view name located in the left sidebar.
2. Click on the `Duplicate` option from the view context menu.
3. Enter the desired new view name into the provided field.
4. Click on the `Duplicate View` button in the confirmation dialog.
![image](/img/v2/views/view-context-menu.png)
![image](/img/v2/views/duplicate-confirmation.png)
## Delete view
:::danger
**This action cannot be undone.**
:::
1. Click on the ellipsis symbol (`...`) next to view name located in the left sidebar.
2. Click on the `Delete` option from the view context menu.
3. Click on the `Delete View` button in the confirmation dialog.
![image](/img/v2/views/view-context-menu.png)
![image](/img/v2/views/delete-view-confirmation.png)

4
packages/noco-docs/docs/080.views/090.view-types/010.grid.md

@ -1,3 +1,7 @@
--- ---
title: 'Grid' title: 'Grid'
--- ---
Grid View, as a default type of view, allows you to display your data in a spreadsheet-like interface using rows and columns. Rows are as referred to as records and columns as fields in NocoDB.
![1010-2 Grid](/img/content/grid.png)

4
packages/noco-docs/docs/080.views/090.view-types/020.gallery.md

@ -1,3 +1,7 @@
--- ---
title: 'Gallery' title: 'Gallery'
--- ---
Gallery View allows you to display images as thumbnails with other fields just like a gallery.
![1010-2 Gallery](/img/content/gallery.png)

4
packages/noco-docs/docs/080.views/090.view-types/030.forms.md

@ -1,3 +1,7 @@
--- ---
title: 'Forms' title: 'Forms'
--- ---
Form View allows you to arrange fields in a form to input data.
![1010-2 Form](/img/content/form.png)
You can drag-drop fields from the form to form-field-menu-bar as required.

4
packages/noco-docs/docs/080.views/090.view-types/040.kanban.md

@ -1,3 +1,7 @@
--- ---
title: 'Kanban' title: 'Kanban'
--- ---
Kanban View allows you to visualise your data using cards at various stacks.
![1010-2 Kanban](/img/content/kanban.png)

BIN
packages/noco-docs/static/img/v2/views/create-view-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 KiB

BIN
packages/noco-docs/static/img/v2/views/create-view-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 167 KiB

BIN
packages/noco-docs/static/img/v2/views/delete-view-confirmation.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

BIN
packages/noco-docs/static/img/v2/views/duplicate-confirmation.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 145 KiB

BIN
packages/noco-docs/static/img/v2/views/locked-view.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

BIN
packages/noco-docs/static/img/v2/views/share-button.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view-copy-link.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view-download.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view-password.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

BIN
packages/noco-docs/static/img/v2/views/view-context-menu.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 155 KiB

Loading…
Cancel
Save