Skip to content

Commit 76070ed

Browse files
[IDP] - Feature : Embedding an Iframe (#11400)
* iframe * Update sidenav.md * release notes * docs: clarify that iframe path segments must be unique in sidenav configuration --------- Co-authored-by: khushisharmaharness <[email protected]>
1 parent 3c308b4 commit 76070ed

File tree

4 files changed

+56
-1
lines changed

4 files changed

+56
-1
lines changed

docs/internal-developer-portal/layout-and-appearance/sidenav.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,35 @@ If you have built a [Custom Plugin](/docs/internal-developer-portal/plugins/cust
9595
to: EntityMyCustomPluginPage
9696
text: MyPlugin
9797
```
98+
99+
## Embedding an Iframe
100+
101+
You can embed an iframe inside the sidenav layout to display external web content directly within your Harness IDP.
102+
103+
![](./static/iframe-embedd.png)
104+
105+
#### Steps to Add an Iframe
106+
107+
1. Navigate to the sidenav layout page.
108+
2. Add a YAML block similar to the example below:
109+
110+
```yaml
111+
- name: SidebarItem
112+
type: iframe
113+
props:
114+
to: iframe/developer_docs
115+
text: Developer docs
116+
url: https://developer.harness.io/
117+
```
118+
119+
When configuring the iframe SidebarItem:
120+
121+
* Use `type: iframe` to specify an iframe element (case-insensitive, so `IfRAmE` also works)
122+
* Configure these properties under `props`:
123+
* `to`: Must follow the format `iframe/${path}` where `${path}` is your custom path segment (this `path` is a unique path i.e. every sidebar item being added must be unique)
124+
* `text`: The label that appears in the sidebar navigation
125+
* `url`: The external URL you want to display within the iframe
126+
127+
:::info
128+
iframes come with certain inherent limitations — for example, OAuth will not work and some websites put limits or block themselves from being rendered inside iframes.
129+
:::
684 KB
Loading

release-notes/internal-developer-portal.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,28 @@ Harness IDP now supports integration with [GitLab](/docs/internal-developer-port
5252

5353
![](../docs/internal-developer-portal/plugins/available-plugins/static/gitlabplugin2.png)
5454

55+
### [New Feature] Iframe Embedding in Sidebar Navigation
56+
57+
Harness IDP now supports embedding external web content directly into your sidebar navigation using iframes. This feature allows you to integrate essential resources, documentation, dashboards, and tools directly into your developer portal interface.
58+
59+
* **External Content Integration** - Add documentation, dashboards, or any web content directly in your IDP navigation
60+
* **Simple YAML Configuration** - Easy to implement with standard sidebar navigation format
61+
62+
#### Example Configuration
63+
64+
```yaml
65+
- name: SidebarItem
66+
type: iframe
67+
props:
68+
to: iframe/developer_docs
69+
text: Developer docs
70+
url: https://developer.harness.io/
71+
```
72+
73+
![](./static/internal-developer-portal/iframe-embedd.png)
74+
75+
[Learn more about embedding iframes in your sidebar](/docs/internal-developer-portal/layout-and-appearance/sidenav#embedding-an-iframe)
76+
5577
### Bug Fixes and Improvements
5678
5779
* **Jira Plugin Enhancements** - We've made several improvements to the Jira plugin:
@@ -255,7 +277,6 @@ The [DX plugin configuration](https://developer.harness.io/docs/internal-develop
255277

256278

257279

258-
259280
### [New Feature] Harness Feature Management & Experimentation Plugin
260281

261282
Harness IDP now includes a native integration with Harness Feature Management & Experimentation (FME), allowing teams to view and manage feature flags directly in their service catalog.
@@ -268,6 +289,8 @@ Harness IDP now includes a native integration with Harness Feature Management &
268289

269290
[Learn more about the Harness FME Plugin](/docs/internal-developer-portal/plugins/available-plugins/harness-native-plugins/harness-fme)
270291

292+
293+
271294
### Bug Fixes and Improvements
272295

273296
* **New Catalog APIs** - Harness IDP now includes two new APIs to make it easier to find and display catalog entities:
684 KB
Loading

0 commit comments

Comments
 (0)