Missing a way to retrieve the ProductContext when using CustomUI

[bjornbrynjar]

With UIKit is easy to retrieve the productContext by using the
UIKit useProductContext hook.

What alternatives do you provide when using CustomUI? I am especially interested in retrieving basic info such as issueKey, accountid so that I can use the REST Api.

Thanks!

[tbinna]

@bjornbrynjar have a looks at Daniel’s comment here on how to return the context from a resolver function:

️ Introducing Custom UI: Static HTML/CSS/JS frontends on Forge

Hey @naiara, Context information is available in the custom UI resolvers. If you do need this information in the UI itself, you can return it from the function. See the following example: In your FaaS function: resolver.define("example-key", ({ payload, context }) => { console.log(context); return { example: `Hello, ${payload.foo}!` }; }); In your custom UI: import { invoke } from '@forge/bridge'; const getData = async () => { const result = await invoke('example-key', { foo: 'bar' …

I was just wondering the same thing and I think there is currently no other way. Something like useProductContext for Custom UI would indeed be very convenient.

[tbinna]

Anyone ending up here after March 2021: It seems there is now an easier way to get the product context in Custom UI code.

The Forge Custom UI bridge now exports a view object which has a getContext() function which returns a Promise with the product context.

import {view} from "@forge/bridge";
view.getContext().then(console.log);

Unfortunately, this is not yet documented but the console output from the snipped above should give an idea of what you get back.

Example output returned from view.getContext() called from an issue action

{
	"cloudId": "my-cloud-id",
	"moduleKey": "my-module-key",
	"extensionContext": {
		"issueId": "11425",
		"issueKey": "ENG-90",
		"issueType": "Story",
		"projectId": "10503",
		"projectKey": "ENG",
		"type": "issueAction"
	},
	"extension": {
		"type": "jira:issueAction",
		"issue": {
			"key": "ENG-90",
			"id": "11425",
			"type": "Story"
		},
		"project": {
			"id": "10503",
			"key": "ENG"
		}
	}
}