Skip to content

Latest commit

 

History

History
144 lines (120 loc) · 4.55 KB

admin-ui-options.md

File metadata and controls

144 lines (120 loc) · 4.55 KB

Admin UI Options

Since version 0.19, Tainacan offers a series of variables that can help you customize the admin panel. Most of this variables mean hidding elements. They can be passed directly to the admin URL as query params, but the ideal way is to use a filter for it. For example:

/*
 * Sends params to the Tainacan Admin Options
 */
function my_plugin_tainacan_admin_options($options) {

	$my_admin_options = [
        'homeCollectionsOrderBy' => 'name',
        'hideTainacanHeaderAdvancedSearch' => true,
        'hideItemsListCreationDropdownImport' => true
    ];
	$options = array_merge($options, $my_admin_options);

	return $options;
};
add_filter('tainacan-admin-ui-options', 'my_plugin_tainacan_admin_options');

The same could be achieved for prototyping by accessing your admin URL like this: https://<your-site.com>/wp-admin/?homeCollectionsOrderBy=name&hideTainacanHeaderAdvancedSearch=true&hideItemsListCreationDropdownImport=true&page=tainacan_admin#/collections/

Follows the complete list of available variables, organized by region of the UI. Notice that some hidding elements variables can be overriden by others:

Home page, Repository Section

  • hideHomeRepositorySection
    • hideHomeThemeCollectionsButton
    • hideHomeThemeItemsButton
    • hideHomeTaxonomiesButton
    • hideHomeMetadataButton
    • hideHomeFiltersButton
    • hideHomeImportersButton
    • hideHomeExportersButton
    • hideHomeActivitiesButton

Home page, Collections Section

  • hideHomeCollectionsSection
    • hideHomeCollectionsButton
    • hideHomeCollectionItemsButton
    • hideHomeCollectionSettingsButton
    • hideHomeCollectionMetadataButton
    • hideHomeCollectionFiltersButton
    • hideHomeCollectionActivitiesButton
    • hideHomeCollectionThemeCollectionButton
    • showHomeCollectionCreateItemButton // Default is false
    • homeCollectionsPerPage // Default is 9
    • homeCollectionsOrderBy // Default is 'modified'
    • homeCollectionsOrder // Default is 'desc'

Tainacan main header

  • hideTainacanHeader
    • hideTainacanHeaderHomeButton
    • hideTainacanHeaderSearchInput
    • hideTainacanHeaderAdvancedSearch
    • hideTainacanHeaderProcessesPopup

Tainacan Repository Menu

  • hidePrimaryMenu
    • hidePrimaryMenuCompressButton
    • hidePrimaryMenuRepositoryButton
    • hidePrimaryMenuCollectionsButton
    • hidePrimaryMenuItemsButton
    • hidePrimaryMenuTaxonomiesButton
    • hidePrimaryMenuMetadataButton
    • hidePrimaryMenuFiltersButton
    • hidePrimaryMenuImportersButton
    • hidePrimaryMenuExportersButton
    • hidePrimaryMenuActivitiesButton
    • hidePrimaryMenuCapabilitiesButton

Tainacan Context Subheader

  • hideRepositorySubheader
    • hideRepositorySubheaderViewCollectionButton
    • hideRepositorySubheaderViewCollectionsButton
    • hideRepositorySubheaderExportButton
  • hideCollectionSubheader

Items list page

  • hideItemsListPageTitle
  • hideItemsListMultipleSelection
  • hideItemsListSelection
  • hideItemsListBulkActionsButton
  • hideItemsListCreationDropdown
    • hideItemsListCreationDropdownBulkAdd
    • hideItemsListCreationDropdownImport
  • hideItemsListAdvancedSearch
  • hideItemsListExposersButton
  • hideItemsListStatusTabs
    • hideItemsListStatusTabsTotalItems
  • hideItemsListContextMenu
    • hideItemsListContextMenuOpenItemOption
    • hideItemsListContextMenuOpenItemOnNewTabOption
    • hideItemsListContextMenuEditItemOption
    • hideItemsListContextMenuCopyItemOption
    • hideItemsListContextMenuDeleteItemOption
  • hideItemsListActionAreas
  • hideItemsListFilterCreationButton

Item edit page

  • hideItemEditionPageTitle
  • hideItemEditionCollectionName
  • hideItemEditionStatusOptions
    • hideItemEditionStatusPublishOption
  • hideItemEditionCommentsToggle
  • hideItemEditionDocument
    • hideItemEditionDocumentFileInput
    • hideItemEditionDocumentTextInput
    • hideItemEditionDocumentUrlInput
  • hideItemEditionThumbnail
  • hideItemEditionAttachments
  • hideItemEditionCollapses
  • hideItemEditionFocusMode
  • hideItemEditionRequiredOnlySwitch
  • hideItemEditionMetadataTypes
  • allowItemEditionModalInsideModal // Not recommended!
  • itemEditionDocumentInsideTabs
  • itemEditionAttachmentInsideTabs

Item single page

  • hideItemSinglePageTitle
  • hideItemSingleCollectionName
  • hideItemSingleCurrentStatus
  • hideItemSingleCurrentVisibility
  • hideItemSingleCommentsOpen
  • hideItemSingleDocument
  • hideItemSingleThumbnail
  • hideItemSingleAttachments
  • hideItemSingleActivities
  • hideItemSingleExposers

Items bulk edition page

  • hideBulkEditionPageTitle