Embedded confluence public

Typescript ❤️

Embedded Confluence components for public consumption.

Install
yarn add @atlaskit/embedded-confluence
npm
@atlaskit/embedded-confluence
Source
Bitbucket
Bundle
unpkg.com
Changelog
Latest

3.0.0

Major Changes

  • #117363 10a0f7f6c2027 - This package's peerDependencies have been adjusted for react and/or react-dom to reflect the status of only supporting React 18 going forward. No explicit breaking change to React support has been made in this release, but this is to signify going forward, breaking changes for React 16 or React 17 may come via non-major semver releases.

    Please refer this community post for more details: https://community.developer.atlassian.com/t/rfc-78-dropping-support-for-react-16-and-rendering-in-a-react-18-concurrent-root-in-jira-and-confluence/87026

Introduction

This package provides components (ViewPage, EditPage, and Page) to any 3rd party product that needs to embed a Confluence page into their products. It also offers the ability create an embedded page from inside a 3rd party product.

Quick Links

What are Embedded Pages?

An embedded page (EP) is a Confluence page that can be integrated into any 3rd party product. It allows 3rd party product users to natively create/edit/view long-form page content within the same product context that they are working in. This promotes a “more powerful together” product experience and eliminates context-switching between the 3rd party product and Confluence.

Goals of Embedded Pages:

1. Deliver value and promote “better together” product experience - Allow 3rd party product users to easily create long form content and collaborate/share knowledge within the context of that 3rd party product, and thereby deriving value from this “windowed” experience.

2. Eliminate context switching - Rather than have users hop over to Confluence to create/edit/view content. We want to bring Confluence pages to you so that users can get started on pages wherever you are.

A note on limitations

When a Forge app uses embedded Confluence pages:

  1. Hyperlinks in the page will not work correctly. Learn more about hyperlinks in Forge.
  2. The login flow for Embedded pages may encounter issues even after the user has granted storage access.
    • Forge apps operate within their own sandboxed (outer) iframe, and this outer iframe imposes restrictions on pop-up windows for security reasons. Learn more about pop-up restrictions in Forge
    • Since pop-ups are necessary for the login page to function properly and enable users to log in to their Atlassian account, the flow will be disrupted at this stage, potentially preventing users from advancing further.