We have an app called FieldCraft: Custom Fields for Jira Cloud, which has been available on the Atlassian Marketplace for some time.
The app defines several customFieldType
modules that use the UI Kit Frame
component to embed a Custom UI resource (details below). Until recently, this setup worked as expected. However, over the past week, the custom fields have stopped working across multiple customer instances. Specifically, the Frame
no longer loads the referenced Custom UI resource.
We would really appreciate any help in investigating and resolving this issue.
We also created ECOHELP-63015 about a week ago but haven’t received a response yet.
We’re reaching out to ask the community:
Is this a general issue affecting Frame + Custom UI
usage, or could it be something specific to our app?
How to reproduce
./manifest.yml:
modules:
jira:customFieldType:
- key: cf-type
name: "Example Custom Field Type"
description: "Example of UI KIT plus Custom UI in Frame"
type: number
readOnly: true
resolver:
function: resolver
contextConfig:
resource: ui # Custom UI, works fine
resource: genericFieldView # UI Kit resource, works fine
render: native
function:
- key: resolver
handler: index.handler
resources:
- key: genericFieldView # UI Kit
path: src/frontend/GenericFieldView.tsx
- key: ui # Custom UI
path: ../ui/build
tunnel:
port: 3003
./src/frontend/GenericFieldView.tsx
import ForgeReconciler, { Frame } from '@forge/react';
import React from 'react';
const GenericFieldView = () => {
console.log('GenericFieldView rendered');
return (
<Frame resource="ui" /> // Problem is here: The Frame isn't loading any content
);
};
ForgeReconciler.render(
<React.StrictMode>
<GenericFieldView />
</React.StrictMode>,
);
2 Likes
We’ve conducted additional tests and it appears that the issue is isolated to the Custom Field (and Custom Field Type) module, specifically related to the usage of Frame within this module.
How to reproduce:
- Clone the repository that contains a standard example of Frame usage:
https://bitbucket.org/atlassian/forge-ui-kit-frame-clean-slate/src/master/
- Add a Custom Field module to the manifest, using the same
"main"
UI Kit resource.
jira:customFieldType:
- key: ui-kit-frame-clean-state
name: ui-kit-frame-clean-state
description: ui-kit-frame-clean-state description
type: string
readOnly: true
resolver:
function: resolver
resource: main
render: native
- Rename “confluence:globalPage” to “jira:adminPage”. Install app to Jira Cloud. The adminPage module works as expected and correctly loads the Custom UI via Frame.
- The Custom Field module, however, fails to load any content within the Frame component.
Frame component in adminPage works fine:
Frame component in custom field doesn’t work:
4 Likes
Hi,
We’re also experiencing the same issue with the Custom Field module and have already opened a support ticket about it. Initially, only the edit view was affected, but as of recently, the frame isn’t working in either view anymore.
1 Like
Dear @dmorrow, @SolomanWeng, @PavloBohdanRavliv,
Is there any chance you could redirect this bug to the appropriate team responsible for Forge?
The Frame component has not been working for the Custom Field module for over two weeks now.
Thank you for your help!
Hi @KaiserSoft, I will look into this and report back.
Hi @KaiserSoft , just a quick update that the issue has been acknowledged on our side and that a fix is being prioritised.
3 Likes
Hi @dmorrow
Is there any update on this?
We’ve recently started seeing the following message:
Frame not supported in view mode
Custom fields can’t render the Frame component in view mode.
Also, the documentation has been updated to include the following note:
Custom rendering can’t be implemented using Custom UI or Frame component.
https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#rendering
Just wondering if there’s any official update or workaround planned for this.
Thanks!
2 Likes