Home > @tridion-sites/extensions
| Variable | Description |
|---|---|
| activitiesExplorerActionGroupId | All built-in action group IDs available in Activities Explorer. |
| activitiesExplorerActionGroupIds | |
| activitiesExplorerActionId | All built-in action IDs available in Activities Explorer. |
| activitiesExplorerActionIds | |
| activitiesExplorerPanelId | All available built-in Activities Explorer panel IDs. |
| activitiesExplorerPanelIds | List of all built-in panel IDs of the Activities Explorer. |
| Block | <p>Serves as the base for most components in the system and provides the most commonly used properties including the className and cssStyle props for custom styling.</p><p>It should rarely be used directly as preference should be given to the more specialized child components.</p> |
| Button | A component that has standard button functionality. |
| Center | <p>This components provides a convenient way to center its child components both vertically and horizontally using a flexbox layout. (see, for example, https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout).</p><p>It is advisable to construct most of the layout using this component as it allows to freely utilize “shouldFill” and similar props that rely on the parent being a Flex component.</p> |
| contentExplorerActionGroupId | All built-in action group IDs available in Content Explorer. |
| contentExplorerActionGroupIds | |
| contentExplorerActionId | All built-in action IDs available in Content Explorer. |
| contentExplorerActionIds | |
| contentExplorerInsightsPanelId | All available built-in Content Explorer panel IDs. |
| contentExplorerInsightsPanelIds | List of all built-in panel IDs of the Content Explorer. |
| contentExplorerPanelId | Backwards compatibility for contentExplorerInsightsPanelId |
| contentExplorerPanelIds | Backwards compatibility for contentExplorerInsightsPanelIds |
| createExtensionGlobals | |
| Flex | <p>The primary building block for layout, based on the principles of the flexible box layout module (see, for example, https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout).</p><p>It is advisable to construct most of the layout using this component as it allows to freely utilize “shouldFill” and similar props that rely on the parent being a Flex component.</p> |
| frameworkInfo | |
| getBorderRadius | System-predefined border radiuses. |
| getColorPalette | System-predefined color palette. |
| getOpacityLevel | System-predefined opacity levels. |
| getSpacing | System-predefined spacings. |
| getTransitionDuration | System-predefined transition duration. |
| getZIndex | System-predefined z-index values. |
| Icon | A component used for rendering SVG icons. |
| isFavoritesNodeId | Checks whether the provided nodeId is the ‘Favorites’ node ID. |
| isItemNode | Checks whether the provided node is an item in the system. |
| isItemNodeOfType | Checks if an item in a node, given as the first parameter, is an instance of a constructor, provided as the second parameter. |
| isItemsInProgressNode | Checks whether the provided node is the ‘Items in Progress’ node. |
| isItemsInProgressNodeId | Checks whether the provided nodeId is the ‘Items in Progress’ node ID. |
| isPublicationsNode | Checks whether the provided node is the ‘Publications’ node. |
| isPublicationsNodeId | Checks whether the provided nodeId is the ‘Publications’ node ID |
| isRootNode | Checks whether the provided node is the ‘Root’ node. |
| isRootNodeId | Checks whether the provided nodeId is the ‘Root’ node ID. |
| isSystemNode | Checks whether the provided node is the ‘System’ node. |
| Link | A component to wrap any custom view with Link for navigation |
| ModalContent | A component to render Content of a Modal |
| ModalFooter | A component to render Footer of the Modal |
| ModalHeader | A component to render Header of the Modal |
| modalStatus | |
| modalStatuses | |
| modalType | |
| modalTypes | |
| navigationItemId | All available built-in navigation item IDs. |
| navigationItemIds | |
| PropertiesList | |
| publishingQueueExplorerActionGroupId | All built-in action group IDs available in Publishing Queue Explorer. |
| publishingQueueExplorerActionGroupIds | |
| publishingQueueExplorerActionId | All built-in action IDs available in Publishing Queue Explorer. |
| publishingQueueExplorerActionIds | |
| publishingQueueExplorerPanelId | All available built-in Publishing Queue Explorer panel IDs. |
| publishingQueueExplorerPanelIds | List of all built-in panel IDs of the Publishing Queue Explorer. |
| Stack | <p>Allows items to be placed one after another with a user defined separation.</p><p>Items can’t have size that depends on Stack’s size. This means that it is impossible to make item take available space or have size in percentage of Stack’s size.</p> |
| Text_2 | Component which renders text with customizable content and styling. |
| TextLink | A component to render Text Link for navigation |
| useActivitiesExplorer | Provides access to Activities Explorer data and methods. |
| useActivitiesExplorerTable | Provides access to Activities Explorer Table data and methods. |
| useActivityInstancesQuery | |
| useAddToBundleMutation | |
| useAssignActivitiesMutation | Assigns a list of activities to a new User or Group. |
| useAssignActivityMutation | Assigns a single activity to a new User or Group. |
| useAutoClassifyItemMutation | Classifies a single item based on its content and metadata. |
| useAutoClassifyItemsMutation | Classifies items based on their content and metadata. |
| useChangeUserLanguageMutation | Updates the language selection for a given user. |
| useChangeUserLocaleMutation | Updates the locale selection for a given user. |
| useConfirmation | Opens a Confirmation Modal based on the provided options. |
| useContainerItems | |
| useContentExplorer | Hook for accessing Content Explorer data and methods. |
| useContentExplorerTable | Hook for accessing Content Explorer Table data and methods. |
| useContentExplorerTree | Hook for accessing Content Explorer Tree data and methods. |
| useCopyItemMutation | Copies a single item to the specified destination. |
| useCopyItemsMutation | Copies a list of items to the specified destination. |
| useCreateTranslationJobMutation | |
| useDefaultTranslationJobQuery | |
| useDeleteItemMutation | Deletes a single item from the system. |
| useDeleteItemsMutation | Deletes a list of items from the system. |
| useDemoteItemMutation | Updates an item by URI. |
| useDemoteItemsMutation | Updates an item by URI. |
| useEditor | Provides access to Item Editor data and methods. |
| useFavoritesQuery | |
| useFinishActivitiesMutation | |
| useFinishActivityMutation | |
| useFinishEditingItemMutation | Finishes editing of a checked out versioned item. Saves changes made in minor version updates and increments the major version of the item. |
| useFinishEditingItemsMutation | Finishes editing for checked out versioned items. Saves changes made in minor version updates and increments the major version of each item. |
| useItemBlueprintHierarchyQuery | Retrieves the context of the provided item within the BluePrint hierarchy. |
| useItemChildrenQuery | Retrieves a list of child items for the provided organizational item. |
| useItemClassifiedItemsQuery | Retrieves a list of items classified with the provided Keyword or Concept. |
| useItemDefaultDataQuery | Retrieves the default model for the provided model type. |
| useItemHistoryQuery | Retrieves a list of major versions of the provided versioned item. |
| useItemPublishedPagesQuery | Retrieves a list of published pages that use the provided item. |
| useItemPublishedToQuery | Retrieves a list of targets to which the provided item is published. |
| useItemPublishUrlsQuery | Retrieves a list of URLs where the provided item is published. |
| useItemQuery | Retrieves a single item using the provided item URI. |
| useItemsInProgressQuery | |
| useItemsQuery | Retrieves a list of items using the provided list of item URIs. |
| useItemsToPublishQuery | Retrieves a list of items that will be published with the provided instructions. |
| useItemsToUnpublishQuery | Retrieves a list of items that will be unpublished with the provided instructions. |
| useItemTranslationInfoQuery | Retrieves translation information for the provided item. |
| useItemUsedByQuery | Retrieves a list of items that use the provided item. |
| useItemUsesQuery | Retrieves a list of items that are used by the provided item. |
| useLocalizeItemMutation | Localizes a shared item by creating a local copy that can then be modified locally. |
| useLocalizeItemsMutation | Localizes a list of shared items by creating their local copies that can then be modified locally. |
| useModal | Opens a Modal based on the provided options. |
| useMoveItemMutation | Moves a single item from its current location to the specified destination. |
| useMoveItemsMutation | Moves a list of items from their current location to the specified destination. |
| useNotifications | Provides access to data and methods for managing notifications. |
| useOptionalActivitiesExplorer | Provides access to Activities Explorer data and methods, if available. |
| useOptionalActivitiesExplorerTable | Provides access to Activities Explorer Table data and methods, if available. |
| useOptionalBundleEditor | Provides access to Bundle Editor data and methods, if available. undefined is returned when used outside of Bundle Editor. |
| useOptionalCategoryEditor | Provides access to Category Editor data and methods, if available. undefined is returned when used outside of Category Editor. |
| useOptionalComponentEditor | Provides access to Component Editor data and methods, if available. undefined is returned when used outside of Component Editor. |
| useOptionalContentExplorer | Hook for accessing Content Explorer data and methods, if available. |
| useOptionalContentExplorerTable | Hook for accessing Content Explorer Table data and methods, if available. |
| useOptionalContentExplorerTree | Hook for accessing Content Explorer Tree data and methods, if available. |
| useOptionalEditor | Provides access to Item Editor data and methods, if available. undefined is returned when used outside of Item Editor. |
| useOptionalFolderEditor | Provides access to Folder Editor data and methods, if available. undefined is returned when used outside of Folder Editor. |
| useOptionalKeywordEditor | Provides access to Keyword Editor data and methods, if available. undefined is returned when used outside of Keyword Editor. |
| useOptionalPageEditor | Provides access to Page Editor data and methods, if available. undefined is returned when used outside of Page Editor. |
| useOptionalPublishingQueueExplorer | Provides access to PublishingQueue Explorer data and methods, if available. |
| useOptionalPublishingQueueExplorerTable | Provides access to PublishingQueue Explorer Table data and methods, if available. |
| useOptionalStructureGroupEditor | Provides access to Structure Group Editor data and methods, if available. undefined is returned when used outside of Structure Group Editor. |
| usePublicationBlueprintHierarchyQuery | Retrieves the context of the provided publication within the BluePrint hierarchy. |
| usePublicationsQuery | |
| usePublishableTargetTypesQuery | Retrieves a list of Target Types for the provided Business Process Type. |
| usePublishingQueueExplorer | Provides access to PublishingQueue Explorer data and methods. |
| usePublishingQueueExplorerTable | Provides access to PublishingQueue Explorer Table data and methods. |
| usePublishItemsMutation | Publishes a list of items with provided instructions. |
| useRemoveFromBundleMutation | Removes a list of items from a given bundle. |
| useRestartActivitiesMutation | Restarts failed activities. |
| useRestartActivityMutation | Restarts an activity which is failed. |
| useRevertItemMutation | Reverts the item to the last major version. If the item does not have a major version, it is deleted. |
| useRevertItemsMutation | Reverts a list of items item to their last major version. If any of the items do not have a major version, they are deleted. |
| useRollbackItemMutation | Rolls back all changes that have been made to an item since a specified version. |
| useSearchInContainerQuery | Retrieves search results within an individual item for the provided input. |
| useStartActivitiesMutation | |
| useStartActivityMutation | |
| useStartWorkflowMutation | Starts a new workflow and associates the bundle and all items inside it with that workflow instance. |
| useSystemSearchQuery | Retrieves search results within the system for the provided input. |
| useUnlocalizeItemMutation | Unlocalizes a single item which removes its local copy from a publication. |
| useUnlocalizeItemsMutation | Unlocalizes a list of items which removes their local copies from a publication. |
| useUnpublishItemsMutation | Unpublishes a list of items with provided instructions. |
| useUpdateItemMutation | Updates an item by URI. |
| useUploadMultimediaMutation | Uploads multimedia files and creates multimedia components out of them. Uploading is done using a queue, which limits the number of files being uploaded at the same time. |
| useUserGroupsQuery | |
| useUserProfile | Provides access to user profile data and methods. |
| useUserProfileQuery | Retrieves user profile data of the currently logged-in user. |
| useUsersQuery |