alfresco-content-app/docs/features/document-list-layout.md
Denys Vuika c8b99b9d29
1.7.0 (#1037)
* remove deprecated file

* [ACA-1904] Language labels (#879)

* [ACA-2083] reset router cache on login/logout (#867)

* reset router cache on login/logout

* Update src/app/app.routes.strategy.ts

Co-Authored-By: DenysVuika <denys.vuika@gmail.com>

* merge suggestion

* [ACA-2083] reset content filters on logout

* [ACA-2083] unit tests

* [ACA-2067] Side navigation - highlight element with children only when not expanded (#880)

* highlight parent element condition

* update test

* e2e

* add context menu (#881)

* [ACA-2107] upgrade to ADF latest beta (#882)

* [ACA-2107] upgrade ADF to latest beta

* fix adf sidenav class name

* [ACA-2107] update is-selected to adf-is-selected

* [ACA-2107] add 'adf' prefix to classes name

* [ACA-2107] remove ADF duplicate css style

* [ACA-2107] use 'adf-full-width' class

* [ACA-2107] add 'adf' prefix

* [ACA-1928] e2e improvements - part1 (#883)

* refactor Mark as favourite tests
rename method to be more clear
create separate methods for some checks and actions

* forgot some changes

* refactor delete-undo tests

* some more refactoring

* fix

* [ACA-1928] e2e improvements - part2 (#884)

* refactor Mark as favourite tests
rename method to be more clear
create separate methods for some checks and actions

* forgot some changes

* refactor delete-undo tests

* some more refactoring

* fix

* small improvements / refactoring

* upgrade 3rd party dependencies (#886)

* upgrade 3rd party dependencies

* update datepicker

* update code

* remove duplicated strings, use ADF instead (#887)

* extension recommendations

* [ACA-1558] cache busting for index.html (#888)

* use dynamic columns from ADF (#889)

* upgrade to latest ADF 3.0.0 alpha

* migrate to ADF column components

* use dynamic column from ADF

* fix e2e tests

* [ACA-2122] automatic code formatting on commit (#890)

* [ACA-2120] update library toolbar (#891)

* [ACA-2131] fix leave library icon for context menu

* remove moment-es6 usage (#892)

* [ACA] Create Library - switch to ADF component (#893)

* use adf component

* fix component name locator

* update extension registration docs

* fix SSO defaults

* fix pre-commit issue with partial commits

* [ACA-2116] search results available actions (#895)

* add item.id to File Libraries

* add method to wait for node to be indexed

* create separate methods in queries API to wait for sites or wait for nodes

* improvements, renaming

* renaming

* fix

* add tests for actions on search results

* add wait and use new method

* fix

* another fix

* use correct method

* more fixes

* create method for clickView button

* fixes

* no message

* unified format for viewer sub-menus (#901)

* unified format for viewer sub-menus

* fix tests

* update prettier

* [ACA-2157] Added basic ABN metadata (#902)

* upgrade to latest JS-API and ADF (#896)

* improved update script and latest ADF libs

* upgrade to latest js-api and ADF

* upgrade tests

* update viewer code

* use @alfresco/js-api

* update to latest adf

* fix deprecation issues

* update viewer

* fix copy/move dialog

* change expect

* fix remove site from favorites

* fix unit test

* update adf version

* use ADF upload dialog

* [ACA-820] add tests for Copy content (#899)

* add tests for Copy content

* fix

* forgot some ids

* update expected favorites number

* support for SSO settings (#905)

* [ACA-2157] Fixed structure, markup and links (#904)

* [ACA-2157] Added brief description and updated links

* [ACA-2157] Fixed broken image URL

* [ADF-2157] Added YAML index file for ABN (#903)

* [e2e] new reporter (#906)

* try new reporter

* run specific suite for testing purposes

* change folder output for report

* more report settings

* remove fdescribe

* remove package and update package-lock

* remove disabled tests not needed by the new reporter

* try to identify cause of travis failure

* run only specific tests for investigation purpose

* remove sleep and increase retry delay

* try a different fix

* revert to previous fix

* try different expects

* call different js-api method

* remove parameter not needed anymore

* upgrade dependencies (#907)

* add tests for Move content (#908)

* [ACA-213] Edit Offline (#909)

* WRITE_LOCK evaluator

* evaluate actions for WRITE_LOCK

* edit offline action

* DL icon for WRITE_LOCK files

* edit offline directive

* custom name column

* localisation

* toggle offline edit extension

* move takeUntil operator

* add tooltip

* better selector to differentiate Edit folder from Edit Offline

* default to empty object for null properties object

* isPersonalFiles evaluator

* isLibraryFiles evaluator

* isLibraryFiles evaluator

* isPersonalFiles evaluator

* update canEditLockedFile rule

* upgrade libraries (#910)

* upgrade libraries

* fix breaking changes

* fix divider

* remove header workarounds

* update repository to 6.1.2-ga, SSO example (#914)

* remove old compose, update to 6.1.2-ga

* SSO with vanilla keycloak

* [ACA-2162] allow custom icons with navbar (#917)

* allow custom icons with navbar

* fix breaking change

* update protractor settings

* pin typescript version, regenerate lock file

* [ACA-2168] auto-generate licenses for docker image (#918)

* auto-generate licenses for docker image

* update version label

* make app agnostic

* [ACA-213] Edit Offline - permissions (#911)

* edit offline action rules

* unlock node error message

* update extensions rules

* lock unlock evaluators

* LockNodeDirective over EditOfflineDirective

* disable tests failing cause of unrelated bug

* isUserWriteLockOwner over isUserWriteLock

* fix lock icon for retina displays

* [ACA-2164] Node version action (#916)

* export upload effects and actions

* remove node version effect and action

* remove node version theme

* change old version manager implementation

* get node info from store selection

* upload version dialog container

* node version form

* update app module

* upload version effect and action

* update version action

* internationalization

* refresh on upload version

* remove old implementation tests

* remove adf-version-manager dialog implementation

* revert adf version component

* fix viewer version action

* [ACA-2160] add tests for Edit offline actions availability (#921)

* add tests for Edit offline actions availability

* fix delete / undo delete tests

* Keensoft AOS extension (#920)

* aos extension

* update karma

* lint improvements and fixes

* update script

* update scripts

* update scripts

* reduce about 56.4 kB of polyfills for modern browsers

* deficated aosHost value to have AOS on separate servers

* context menu and toolbar

* visibility evaluator

* code improvements and fixes

* support locking, lock checks

* [ACA-2193] Lock node - unlock after new version is uploaded (#924)

* unlock node api call

* unlock action and effect

* unlock node after version upload

* check if locked

* clear version input on dialog cancel event

* update viewer on node version upload

* update viewer on file upload delete

* test

* update tests

* update tests

* rename evaluators

* update docs

* minor script improvements

* update AOS extension docs and version

* update package configuration for AOS ext

* update AOS extension details

* Search on mobile opens Sidemenu (#929)

* Added a check for mobile pages to prevent sidemenu opening

* [ACA-2200] Upgrade to 3.0.0-beta9 ADF (#931)

* upgrade to latest ADF 3.0.0-alpha

- remove selectedFacetQueries check
- renamed hasPermission from ADF ContentService to hasAllowableOperations

* update to ADF 3.0.0-beta9

* [ACA-2200] mincount workaround

- until we get the fix for the facet update issue (ADF-3401)

* [ACA-2171] enable copy and move to library tests (#933)

* [ACA-2198 ACA-2206]  Node version - align dialog with XD (#937)

* make comment field not required

* make Minor default version option

* tests

* fix form version options label

* test form state on initialization

* [ACA-2210] Version Dialog - update button text (#939)

* dialog action buttons text to uppercase

* dialog text Cancel over Close

* update translation reference

* [ACA-213] Upload Version - version options use boolean values (#940)

* version form data interface

* subscribe value data type

* use form data  boolean value

* update tests

* [ACA-2208] Hide app menu on swipe (#934)

* mobile: hide app menu on swipe left

* check for mobile screen size

* space for click out on small devices

* added test

* fix test

* [ACA-2199] Upload Version - granular permission   (#938)

* canUploadVersion evaluator

* change upload version action rule

* update docs

* simplify condition

* unit tests and code fixes

* [ACA-2211] auth guard: add support for withCredentials (#942)

* auth guard: add support for withCredentials

* formatting fixes

* remove fdescribe

* [ACA-2204] Upgrade to ADF 3.0.0 release (#949)

* upgrade to ADF 3.0.0

* update unit tests

* disable versioning tab in info drawer (#941)

* [ACA-213] Version Dialog - tests (#948)

* enable Esc action to close dialog

* version dialog form tests

* test fix

* [ACA-2193] Upload new content version - unsubscribe upload event (#925)

* remove console log

* unsubscribe upload event after new version

* unit tests

* update AOS extension to ADF 3.0.0

* Upgrade libs (#952)

* update libs

* remove i18n workaround

* node locking  enhancements and fixes (#955)

* optimize image resolver

* allow previewing locked files

* allow selecting locked nodes

* fix comments and metadata tabs

* improved lock checks

* remove obsolete "experimental" directive

* [ACA-2177] Actions - rearrange actions order  (#922)

* rearange actions

* remove separator duplication

* don't show last divider element

* update e2e

* update e2e

* Update toolbar-single-selection.test.ts

remove fdescribe

* move comment as well

* edit folder locator

* edit folder action

* edit folder action from toolbar more menu

* edit folder context menu id

* dont render versions tab

* [ACA-2199] fix Upload New Version action availability (#959)

* fix Upload New Version action availability

* update unit tests

* remove workaround

* add catch for tests failing on Bamboo

* add new line

* add tests for Upload New Version (#960)

* remove separator between Favorite and Edit folder (#963)

* [ACA-2221] Lock node - check selection is not null (#966)

* check selection is not null

* test

* add tests for downloading a single file (#967)

* [ACA-833] automate tests for download as zip (#968)

* add tests for downloading a single file

* automate tests for download as zip

* [ACA-2216] Shared link preview - use extension actions (#964)

* isSharedFileViewer evaluator

* navigation evaluators tests

* update docs

* fallback for SharedLink entry

* shared link view use extensions

* rules for link shared view actions

* dedicated extension definition for shared link action toolbar

* resolve selection and actions

* update tests

* remove un used imports

* nest shared link viewer toolbar actions in to viewer structure

* [ACA-2180] Viewer toolbar - rearrange actions layout (#962)

* merge action in toolbar submenu

* viewer add info drawer action

* toggle infoDrawer extension action

* hide viewer toolbar info drawer action

* fix typo

* allow to  unsubscribe from infoDrawerOpened event

* [ACA-2207] Upload Dialog - restore previous version on delete (#951)

* restore version over delete node

* apply prettier

* clean up unnecessary dependencies

* remove style file

* set CANCEL status on on deleted node version instances

* Update upload.module.ts

remove extra licence text

* fix typo

* remove duplicate strings

* [ACA-2212] allow "edit in office" only for basic auth (#971)

* allow AOS only for basic auth for now

* bump aos extension version

* [ACA-2208] Hide app menu on swipe (#970)

* [ACA-2220] simple "search in fields" support (#972)

* simple "search in fields" support

* unit tests

* add separator (#974)

* [ACA-2222] add e2e tests for pagination on Favorite Libraries (#969)

* add tests for pagination on Favorite Libraries

* add TestRail ids
add tests for pagination for empty page and single page

* Delete package-lock.json

* Revert "Delete package-lock.json"

This reverts commit 41eba0c57532373d87d454372273b54ba00e880a.

* restore package-lock

* [ACA-2219] support more precise searching (#976)

* support more precise searching

* exact term matching

* remove fdescribe

* update docs

* [ACA-1259] automate remaining tests for sidebar (#977)

* automate remaining tests for sidebar

* formatting

* reload active doclist via NgRx actions (#978)

* doclist reload action and effect

* deprecate folderEdited event

* deprecate "favoriteToggle" event

* deprecate "favoriteRemoved" event

* update docs

* unified reload function

* deprecate "nodesRestored" event

* deprecate "nodesPurged" event

* test fixes

* deprecate "nodesMoved" event

* reduce the use of "nodesDeleted"

* [ACA-2229] run aca nginx as non-root (#979)

* run aca nginx as non-root

* remove edit permissions from html folder

* [ACA-2229] docker security fixes (#980)

* docker permission fixes

* remove index.html edit permissions

* support repository info with app state (#984)

* [ACA-2214] Sharing URL being constructed from ECM Host incorrectly (#981)

* fix baseShareUrl defaults

* allow controlling full path

* unit test

* update tomcat settings

* use single slash

* simplify documentation

* [ACA-2194] better custom aspects in metadata tab (#985)

* better custom aspects in metadata tab

* update test

* fix lockby position (#986)

* compatibility matrix (#989)

* [ACA-2228] Add PipeModule to AppTestingModule (#993)

- fixes unit tests after upgrade to 3.1.0-beta4

* responsive breadcrumb (#990)

* [ACA-2239] initial localisation support for AOS extension (#988)

* setup i18n for aos extension

* translate action names, generic icon

* unit tests and bug fixes

* use AOS testing with CI

* [ACA-2242] add old style back (#994)

fixes missing buttons styles issue until ADF 3.1.0 will fix it

* upgrade libs to latest versions (#996)

* Windows compatibility

* [ACA-2195] fix redirect on login after page reload (#997)

* fix build script for Windows

* update evaluator docs, workspace snippet (#995)

* add missing docs and code hints

* update app evaluator docs and code hints

* fix route url special characters (#1000)

* revert change for AOS related to lock owners

* [ACA-2215] toggle search filter (#998)

* support for toggling search filter

* update docs

* disable e2e test

* update e2e

* [ACA-2133] fix application ready event for kerberos (#1002)

* fix application ready event for kerberos

* format file

* spellcheck fixes

* hide AOS when in trashcan

* fix broken test

* [ACA] Search - show error message on error (#1003)

* show error message

* remove fdescribe

* add documentation on SSO, minor docs fixes (#1005)

* menu filter disabled items (#1009)

* 1.7.0

* [ACA-2261] improve UX on search input (#1004)

* Remove search on change

- search call would be triggered only on submit or on option change

* clicking search icon triggers search

* caches user changes for a possible future search

* caches non-empty user changes for a possible future search

* close search options menu on submit

* update queryBuilder and navigate to new search url

* add setting to enable/disable searching after typing on search input

* fix double search call

* Apply suggestions from code review

- custom name to distinguish between ADF and ACA settings

Co-Authored-By: suzanadirla <dirla.silvia.suzana@gmail.com>

* [ACA-2264] fix loading on search (#1011)

- do nothing on null built query

* readme update

* update readme

* [ACA-1627] add automated tests for Comments (#1012)

* bump runtime version for core extension

* json schema fixes

* [ACA-2260] Open in Office - action breaks application in IE (#1014)

* ie office luncher workaround

* open office without location navigation

* check instance before remove

* various bug fixes (#1010)

* various bug fixes

* use 'remove favorite' label where appropriate

* fix toggle favorite component labels

* e2e type check and fixes

* favorite library label

* support toggle favorite component selectors

* update tests

* update e2e tests

* update e2e

* e2e update

* update e2e

* [ACA-2259] Edit in Microsoft Office - check update permissions (#1015)

* [ACA-2259] Edit in Microsoft Office - check update permissions

* [ACA-2259] check update permissions - unit tests

* [ACA-2259] refactor - check allowableOperationsOnTarget from service

* [ACA-2259] add back check only on target for SharedFiles

* [ACA-2259] SharedLinks are not folders

* type-safe api for node permissions

* workaround for shared files

* use hasOwnProperty function

* fix visibility evaluation for create menu (#1017)

* [ACA-2270] allow add comments on folder (#1018)

* [ACA-2270] allow add comments on folder

* [ACA-2270] fix return on else

* [ACA-2270] add unit tests

* update translations (#1023)

* assert file extension validity first (#1025)

* hide empty metadata by default (#1024)

* update copyright year (#1022)

* update copyright year

* forgot a file

* update year on licence header

* extensions flag inside settings page

* support "disabled" rules for Viewer extensions

* set relevance descending by default (#1027)

* [ACA-2284] Shared Link - Error when trying to download a shared file (#1026)

* shared link content download action

* use same action and effect

* call appropriate api baes on location

* remove unused property

* remove unneeded divider from toolbar (#1028)

* use LTS node.js (#1031)

* Update README.md (#1032)

* Update README.md

* Update README.md

* Update introduction-to-extending.md

* Update search-results.md (#1034)

* Update document-list-layout.md (#1035)

* Update README.md (#1033)

* Update README.md (#1036)

* [ACA-2299] fix search error translation (#1030)

* fix search error translation

* fix translation fallback

* remove fdescribe
2019-03-22 14:51:40 +00:00

102 lines
7.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
Title: Document List Layout
---
# Document List Layout
The main area of the application is composed of several individual ADF components:
1. [Breadcrumb](https://www.alfresco.com/abn/adf/docs/content-services/breadcrumb.component/)
2. [Toolbar](https://www.alfresco.com/abn/adf/docs/core/toolbar.component/)
3. [Document List](https://www.alfresco.com/abn/adf/docs/content-services/document-list.component/)
4. [Pagination](https://www.alfresco.com/abn/adf/docs/core/pagination.component/)
![](../images/doclist.png)
The application has seven different Document List views which share commonalities between each view and subtle differences depending on the content being loaded which are explained below.
## Personal Files
Personal Files retrieves all content from the logged in user's home area (`/User Homes/<username>/`) in the repository;
if the user is admin who does not have a home folder then the repository root folder is shown.
Personal Files is the [Files](../../src/app/components/files) component,
using the [Nodes API](https://api-explorer.alfresco.com/api-explorer/#/nodes).
## File Libraries
File Libraries retrieves all the sites that the user is a member of including what type of site it is: public, moderated or private.
File Libraries is the [Libraries](../../src/app/components/libraries) component,
using the [Sites API](https://api-explorer.alfresco.com/api-explorer/#/sites).
When a user opens one of their sites then the content for the site's document library is shown.
To display the files and folders from a site (`/Sites/<siteid>/Document Library/`) the [Files](../../src/app/components/files) component,
using the [Nodes API](https://api-explorer.alfresco.com/api-explorer/#/nodes) is used.
## Shared Files
The Shared Files view aggregates all files that have been shared using the QuickShare feature in the content repository.
The [Shared Files](../../src/app/components/shared-files) component uses the [shared-links API](https://api-explorer.alfresco.com/api-explorer/#/shared-links)
and includes extra columns to display where the file is located
in the content repository and who created the shared link.
## Recent Files
The Recent Files view shows all the files that have been created or modified within the last 30 days by the current user.
The [Recent Files](../../src/app/components/recent-files)
component uses the Search API to query SOLR for changes made by the user and includes an extra column to display where the file is located
in the content repository.
## Favorites
The Favorites view shows all files and folders from the content repository that have been marked as a favorite by the current user.
The [Favorites](../../src/app/components/favorites) component uses the
[favorites](https://api-explorer.alfresco.com/api-explorer/#/favorites) API to retrieve all the favorite nodes for the user
and includes an extra column to display where the file is located
in the content repository.
## Trash
The Trash view shows all the items that a user has deleted, admin will see items deleted by all users.
The actions available in this view are Restore and Permanently Delete.
The [Trashcan](../../src/app/components/trashcan) component uses the
[trashcan](https://api-explorer.alfresco.com/api-explorer/#/trashcan) API to retrieve the deleted items
and perform the actions requested by the user and includes an extra column to display where the item was located
in the content repository before it was deleted.
## Search Results
The Search Results view shows the found items for a search query. It has a custom layout template and users can easily browse the results and perform actions on items.
For more information on the [Search Component](../../src/app/components/search), please also check this [Search Results](/features/search-results) section.
Another custom template layout shows the results when searching for libaries so that users can find, join and favorite libraries that they aren't already members of.
## Actions and the Actions Toolbar
All the views incorporate the [toolbar](https://www.alfresco.com/abn/adf/docs/core/toolbar.component/)
component from the Alfresco Application Development Framework.
Actions are displayed in the toolbar when item(s) are selected, or a right click is performed; apart from the Trash view they all display the following actions when the current user has the necessary permissions,
actions are automatically hidden when the user does not have permission.
| Action | File | Folder |
| -- | -- | -- |
| Edit in Microsoft Office | Opens Word, Powerpoint and Excel files directly in your Microsoft Office applications, requires Alfresco Office Services | Not applicable |
| Edit offline | Downloads the file and locks it in the repository for offline editing | Not applicable |
| Upload a new version | Upload a new version for the selected file | Not applicable |
| Share | Create and copy a link to a file that can be shared, the links are accessible without granting permissions to the file, and do not require users to login to the application. Share links can automatically expire based on a date, the minimum expiry date is controlled by the Content Services repository, which is 1 day from the date of creation. | Not applicable |
| Download | Downloads single files to the user's computer, when multiple files are selected they are compressed into a ZIP and then downloaded. | Folders are automatically compressed into a ZIP and then downloaded to the user's computer. |
| View | Opens the selected file using the [Preview component](../../src/app/components/preview). If the file cannot be displayed natively in a browser, a PDF rendition is obtained from the repository. | Not applicable |
| Edit | Not applicable | The folder name and description can be edited in a dialog. |
| Favorite | Toggle the favorite mark on or off for files and folders. If multiple items are selected and one or more are not favorites then the mark will be toggled on. |
| Copy | Files and folders can be copied to another location in the content repository using the [Content node selector component](https://www.alfresco.com/abn/adf/docs/content-services/content-node-selector.component/). When the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies). |
| Move | Files and folders can be moved to another location in the content repository using the [Content node selector component](https://www.alfresco.com/abn/adf/docs/content-services/content-node-selector.component/). When the move action has completed the user is notified and can undo the action (which moves the items back to the original location). |
| Delete | Files and folders can be deleted from their location in the content repository. When the delete action has completed the user is notified and can undo the action (which restores the items from the trash). |
| Manage Versions | Versions of files can be viewed, uploaded, restored, downloaded and deleted by using the version manager dialog. When each action has completed the list of versions is updated according to the change. | Not applicable |
| Permissions | Permissions on a file can be adjusted as required in a number of ways; disable inheritance from the parent folder, change a user or groups role and grant users/groups access. | Not available |
Besides the actions available in the toolbar users can
* single click on a file to view it, and a folder to open it
* single click an item to select it
* double click on a file to view it, and a folder to open it