Filter by keyword
Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules
Rovo modules

Bitbucket repository code overview panel

On This Page

    The bitbucket:repoCodeOverviewPanel module adds an expandable panel on the repository source page.

    When the header is clicked, the panel is expandable/collapsible to display/hide custom information defined by the Forge app.

    Example of a repository code overview panel

    Properties

    PropertyTypeRequiredDescription
    key

    string

    		Yes

    A key for the module, which other modules can refer to. Must be unique within the manifest.

    Regex: ^[a-zA-Z0-9_-]+$

    resourcestringIf using Custom UI or modern versions of UI KitThe key of a static resources entry that your module will display. See resources for more details.
    render'native'If using modern versions of UI KitIndicates the module uses UI Kit.
    functionstringDeprecated Required if using UI Kit 1The key of a function module that returns a UI Kit 1 component.
    resolver{ function: string } or
    { endpoint: string }

    Set the function property if you are using a hosted function module for your resolver.

    Set the endpoint property if you are using Forge remote to integrate with a remote back end.

    titlestring or i18n objectYes

    The title of the panel, which is displayed as the panel header.

    The i18n object allows for translation. See i18n object.

    i18n object

    KeyTypeRequiredDescription
    i18nstringYesA key referencing a translated string in the translation files. For more details, see Translations.

    Extension context

    UI Kit and Custom UI

    Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

    PropertyTypeDescription
    typestringThe type of the module.
    repositoryobjectThe repository where this panel is displayed in.
    repository.uuidstringThe repository UUID which will be wrapped in {}.
    locationstringThe full URL of the host page where this panel is displayed in.

    Some Forge APIs (for example, storage API) do not support {}. You can use the unwrapUUid and wrapUuid functions to convert a Bitbucket resource ID between a wrapped and unwrapped UUID. See unwrapUuid/wrapUuid helper functions for more information.

    UI Kit 1

    Use the useProductContext hook to access the context in the UI Kit 1.

    Please note that UI Kit 1 is being deprecated.

    PropertyTypeDescription
    typestringThe type of the module.
    repositoryobjectThe repository where this panel is displayed in.
    repository.uuidstringThe repository UUID which will be wrapped in {}.
    locationstringThe full URL of the host page where this panel is displayed in.

    Rate this page: