Skip to content

feat: add type to nav-header - #120

Merged
nexus49 merged 3 commits into
mainfrom
nav-header
Feb 26, 2026
Merged

nexus49 merged 3 commits into
mainfrom
nav-header

Conversation

@Sobyt483

@Sobyt483 Sobyt483 commented Feb 25, 2026 •

Copy link
Copy Markdown
Contributor

related to openmfp/portal-ui-lib#584

Summary by CodeRabbit

  • Documentation
    • Clarified navigation header configuration: static header now accepts an optional "type" property alongside "icon" and "label".
    • Updated guidance for dynamic header titles: the resolver property name has changed — follow the new title-resolver naming when configuring dynamic headers. Existing control flow and other fields are unchanged.

@Sobyt483
Sobyt483 requested a review from a team as a code owner February 25, 2026 09:25
@Sobyt483 Sobyt483 self-assigned this Feb 25, 2026
@Sobyt483 Sobyt483 added the documentation Improvements or additions to documentation label Feb 25, 2026
@coderabbitai

coderabbitai Bot commented Feb 25, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83fa0ec and c6ff2e4.

📒 Files selected for processing (1)
  • documentation/extended-guide/content-configuration.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • documentation/extended-guide/content-configuration.md

📝 Walkthrough

Walkthrough

Static navHeader documentation now documents an optional type property (in addition to icon and label); dynamic navHeader docs rename the resolver property from use to useTitleResolver and require useTitleResolver to be set to titleResolver. No functional code changes are described.

Changes

Cohort / File(s) Summary
Documentation Update
documentation/extended-guide/content-configuration.md
Static navHeader docs updated to include an optional type property alongside icon and label. Dynamic navHeader docs changed to use useTitleResolver (previously use) and indicate it should be set to titleResolver.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • gkrajniak
  • tjbutz

Poem

🐰
I hopped through docs with ink and cheer,
A tiny "type" now tiptoes near,
The title resolver found its name,
Little changes, same bright frame,
Hooray — the guide's a bit more clear!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: add type to nav-header' directly aligns with the main change: adding an optional type property to the navHeader static definition.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch nav-header

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Sobyt483 Sobyt483 moved this to Waiting For Review in OpenMFP Development Feb 25, 2026
@github-actions

github-actions Bot commented Feb 25, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.6.3
Preview removed because the pull request was closed.
2026-02-26 07:51 UTC

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@documentation/extended-guide/content-configuration.md`:
- Line 409: Update the navHeader documentation sentence that currently reads
"statically by setting **icon**,  **type**  and **label** properties, where icon
can be an url to an image or an identifier of an icon." to tighten spacing and
fix grammar: remove the extra spaces around **type**, change "an url" to "a
URL", and ensure consistent punctuation so it reads like "statically by setting
the **icon**, **type**, and **label** properties, where **icon** can be a URL to
an image or an icon identifier." Reference the navHeader docs and the properties
**icon**, **type**, **label** when applying the edit.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd680c3 and 83fa0ec.

📒 Files selected for processing (1)
  • documentation/extended-guide/content-configuration.md

@Sobyt483
Sobyt483 enabled auto-merge (squash) February 25, 2026 16:26
@nexus49
nexus49 disabled auto-merge February 26, 2026 07:50
@nexus49
nexus49 merged commit bc79cb8 into main Feb 26, 2026
2 checks passed
@nexus49
nexus49 deleted the nav-header branch February 26, 2026 07:51
@github-project-automation github-project-automation Bot moved this from Waiting For Review to Done in OpenMFP Development Feb 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants