@atlassian/clientside-extensions-docs

Client-side Extensions Docs

This repository contains the developer documentation for client-side extensions. Documentation is written in Markdown and published to the Atlassian npm repository.

These docs will be published at:

https://developer.atlassian.com/server/framework/clientside-extensions

Preview

yarn preview

This will first install the Docker image needed to run the Atlassian Docs locally, and then start the server with the content locally at:

http://localhost:8080/server/framework/clientside-extensions

Validation

yarn validate

Will check that all the links work correctly, and all metadata in the MD files are correct.

Spellcheck

yarn spellcheck

You can add your own words to the dictionary by editing the .spelling file of this package.

Changelog

[0.9.0] - 2020-02-18

Added

• setActions and onClose methods has been added to the top level ModalAPI. They will replace the ones provided as "options" in onMount modal method.
• setWidth and setAppearance methods have been added to ModalAPI.
• setAction ModalAPI now can an accept a new testId property. You can use this property to write unique selectors while working on the e2e tests.

Fixed

• Runtime no longer bundles React/AJV.
• The existing JSON schema fields like label, url, title are not getting overwritten with default values.
• Attributes are now validated also when calling updateAttributes.

Changed

• BREAKING CHANGE: The useDebug, useValidation, useLogging, useDiscovery React hooks were removed from the @atlassian/clientside-extensions-debug package and moved to the @atlassian/clientside-extensions-components package.
• Runtime no longer validates the type of extensions in production mode.

Deprecated

• setActions and onClose Modal Options API is deprecated in favor for their counterparts in ModalAPI. They are still available for you to use, but will be removed on a later version.