* items semi complete
* updated items page to use snippet toggler and migrated endpoint docs to use it
* updated files page to use snippet toggler and migrated REST and GraphQL endpoint docs to it
* updated activity page to use snippet toggler and migrated REST and GraphQL endpoint doc to it
* updated collections page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* updated dashboards page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated extensions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated fields page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated flows page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated folders page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated notifications page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated operations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated panels page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated permissions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated presets page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated relations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated revisions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated roles page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Made headlines consistant with the rest of the doc pages
* Updated server page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated settings page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated shares page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated translations page to use snippet togglers and migrated REST endpoint docs to them
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated utilities page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated webhooks page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated authentication page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated Global Parameters page to use snippet togglers where there are adjacent REST and GraphQL Examples
* Added SDK code snippets to items page and made generic variables consistant
* Added SDK code snippets to files page and made generic variables consistant
* Few lang changes for files page
* Added SDK code snippets to activity page and made generic variables consistant
* Added SDK code snippets to collections page and made generic variables consistant
* Added SDK code snippets to dashboards page and made generic variables consistant
* removed query word from query parameter objects
* Added SDK code snippets to fields page and made generic variables consistant
* SnippetToggler border
* Used dynamic border color for snippettoggler heading
* Spacing top and bottom of snippet toggler in docs
* Removed extra HRs
* Remove manual TOC in query reference
* Small code styling change in items page
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* dashboards fixed up property names
* Small copy update on extensions page
* Updated keys in delete mult notifications REST
* Updated keys in operations
* Update keys in panel delete many
* Update keys in permissions
* Added quotes around generic example ID strings
* Added code formatting to final example in share public info
* Format files
* Refined sidebar
* Insert newline before ending template tags
* Fixed extra closing tags, causing an error, un users ref
* Text Formatting Users
* Put GQL related notes inside toggler
* Added SDK code snippets to flows page and made generic variables consistant
* Added SDK code snippets to folder page and made generic variables consistant
* fixing whitepsace for flows and folders page
* Consistent newlines in SnippetToggler usages
* Run prettier
* Fix 'alwaysDark' definition
* Home page snippet toggler style fixes
* Fix snippet toggler lang hover color in light mode
* Introduce different code theme for light mode
* Added SDK code snippets to notifications page and made generic variables consistant
* Switch to 'material-theme-lighter'
* Format file
* Fix tip
* Fix tip in sdk ref
* Consistent spacing for custom containers
* Added SDK code snippets to operations page and made generic variables consistant
* Lint & format code blocks
* Lint & format operations
* Added SDK code snippets to panels page and made generic variables consistant
* Added SDK code snippets to permissions page and made generic variables consistant
* Added SDK code snippets to presets page and made generic variables consistant
* Added SDK code snippets to relations page and made generic variables consistant
* Added SDK code snippets to revisions page and made generic variables consistant
* Added SDK code snippets to roles page and made generic variables consistant
* Added SDK code snippets to server page and made generic variables consistant
* Added SDK code snippets to settings page and made generic variables consistant
* app_url -> directus_project_url
* Omitted auth details in delete multiple files
* Added quotes to values in roles
* Upload a file snippets
* Pluralization for upload/import files
* More files functions typos
* Added SDK code snippets to shares page (still missing createShare(s) as endpoint not functioning currently) and made generic variables consistant
* Added SDK code snippets to translations page (missing delete endponts because not working) and made generic variables consistant
* Added SDK code snippets to users page and made generic variables consistant
* Added SDK code snippets to webhooks page and made generic variables consistant
* Added SDK code snippets to utilites page (except cleaning cache, will be tested and added in later commit) and made generic variables consistant
* Added SDK code snippets to auth page (not login, refresh, and logout though due to errors)
* Added SDK code snippets for utilsExport and clearCache
* added github username be7DOTis to contributors
* Omit auth commands in updateComment
* utilsImport
* rename app_url generic value
* changed instances of updated*operation* to update*Operation*
* missed some 'updated' changse
* Added SDK Snippets to Query Parameters page
* Add section on file security
* added create(s)Shares SDK snippet to shares page
* added console.log to create snippets
* Added delete(s)Webhook SDK snippet to webhooks page
* Added SDK snippets to extensions page
* Added create/updateSingleton section to items page
* Links in files security
* Added SDK Snippets to Schema page
* Added GQL Generic examples to snippet togglers and removed snippet toggler from Login Using SSO Providers
* Added create(s)Presets SDK Snippets to presets page
* replaced fields query in generics snippets for a more generic
* replaced fields query in generics snippets for a more generic
* Use storage value only if valid choice
* Sync snippet togglers across page
* Update docs/reference/system/activity.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/extensions.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/schema.md
* Update docs/reference/system/server.md
* Update docs/reference/system/shares.md
* Replace all directus_project_url placeholders
* Revert "Sync snippet togglers across page"
This reverts commit 8b36f0d778.
* Update docs/reference/system/shares.md
* Update docs/reference/system/webhooks.md
* Clarify singleton section
* Consistent newlines between SnippetToggler templates
* Format files
* Remove console.log(result) statements from snippet
* Add examples for shares & users
Co-authored-by: Brainslug <tim@brainslug.nl>
* Fix hash GraphQL example
* Clarify update singleton section
* Add auth examples
Co-authored-by: Brainslug <tim@brainslug.nl>
* Final run on consistent newlines between SnippetToggler
* Switch to github themes
* The "Last One"
Co-authored-by: Brainslug <tim@brainslug.nl>
* The "Big One"
* Fix dead links
---------
Co-authored-by: Bevis Halsey-Perry <hi@be7.is>
Co-authored-by: Kevin Lewis <kvn@lws.io>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Brainslug <br41nslug@users.noreply.github.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Brainslug <tim@brainslug.nl>
7.7 KiB
description, readTime
| description | readTime |
|---|---|
| The Item Page is a tailored form for managing Items and their Field values. This page also includes options for archiving, reverting, and commenting on the Item. | 5 min read |
Item Page
The Item Page is a tailored form for managing Items and their Field values. This page also includes options for archiving, reverting, and commenting on an Item.
::: tip Programmatically Manage Items
This page shows you how to manage Items within the no-code app. However, you can also manage Items programmatically via the API.
:::
Create an Item
To create an Item, follow these steps.
- Navigate to the Content Module and select the desired Collection.
- Click add in the Page Header to open the Item Page.
- Fill in Item details as desired.
- Click check in the Page Header.
::: tip Singletons
If the collection is configured as a Singleton in the data model settings, the App will skip step two above and automatically open the Item Page.
:::
Edit an Item
To edit an Item's field values, follow these steps.
- Navigate to the Content Module and select the desired Collection.
- Click on the desired Item to open the Item Page.
- Update Item details as desired.
- Click check in the header.
::: tip Other Save Options
To the right of the primary Save button, there is a more_vert menu that contains the following alternate save options:
check Save and Stay (⌘S)
add Save and Create New (⌘⇧S)
done_all Save as Copy
undo Discard all Changes
:::
::: tip Singletons
If the Collection is configured as a "Singleton" in Data Model Settings, then the App will skip step two above and automatically open the Item Page.
:::
Advanced Save Options
To do an advanced save when you create or edit an item, follow these steps.
- Begin to create an item or edit an item.
- Click more_vert to open the context menu.
- Click to choose your advanced save method. You have four options:
- Save and Stay
- Save and Create New
- Save as Copy
- Discard all Changes
Archive an Item
To archive an Item, follow these steps.
- Navigate to the Content Module and select the desired Collection.
- Select the desired Item to open the Item Page.
- Click archive located in the header and a popup will appear.
- Click "Archive" to confirm the action.
::: warning Requires Configuration
Requires an Archive field to be configured within the Collection's data model settings.
:::
Revert an Item
As you update Field Values on Items, Directus saves these Revisions, and they can be compared side-by-side to the current state. To revert an Item, follow these steps.
- Navigate to the Content Module and select the desired Collection.
- Select the desired Item to open the Item Page.
- Click "Revisions" in the page sidebar.
- Click on the revision you wish to preview and a side menu will appear.
- Go to "Revisions Made" in the side menu and view the revision differences.
- Click restore to revert the Item's values and return to the Item Page.
- Click check to confirm and exit to the Collection Page.
::: tip Revision Preview
You will also see a "Revision Preview" button in the side menu navigation, which will let you preview all the Item's values for that revision.
:::
::: tip
You can also revert Items programmatically via the API.
:::
Comment on an Item
Comments is a collaborative tool that are left on an Item in the sidebar and remain there for you and other team members to view. To create a comment, follow these steps.
- Navigate to the Content Module and select the desired Collection.
- Select the desired Item to open the Item Page.
- Click "Comments" in the page sidebar.
- Type your message into the input box.
- Click the "Submit" button.
::: tip Mentions
You can also search and mention any User by typing the "@" symbol along with their name or email to send an in-app notification, as well as an email directing them to your comment.
:::
::: tip Edit and Delete Comments
Each comment displays the time it was created in its upper right-hand corner. Hover over this and the more_horiz menu will appear. Click edit to edit or delete to delete the comment.
:::
Delete an Item
To delete an Item, follow these steps.
- Navigate to the Content Module and select the desired Collection.
- Select the desired Item to open the Item Page.
- Click delete located in the header and a popup will appear.
- Click "Delete" to confirm the action.
::: tip Soft-Delete
If you wish to remove an Item from view or use without fully deleting it, consider archiving the Item instead.
:::
Live Preview an Item
Live preview allows you to preview your content changes without having to publish them. To preview an Item, follow these steps:
- Navigate to Settings > Data Model and choose the Collection.
- Add the "Preview URL" in the "Preview URL" section.
- Go to the Content Module and select the Collection.
- Choose the Item you want to preview.
- Toggle "Enable Preview" at the top of the page.
- Make changes to your Item and save. The preview will appear on the right side of your screen.