What type(s) of user does this feature affect?

• volunteers
• supervisors
• admins

Product Requirements Document (PRD)

Feature: Custom Admin-Defined Navbar Links

1. Overview

This feature allows organization admins to add up to three custom links to the left navigation bar. These links will be visible to all users within the organization but can only be created or edited by admins. The links will be managed through the Edit Organization settings.

2. Objectives

• Enable admins to create up to three custom navbar links.
• Ensure all users in the organization can see and access these links.
• Allow admins to manage links in the Edit Organization section.
• Maintain consistent UI styling with existing navbar elements.
• Provide an "Active" checkbox to enable/disable links.

3. User Stories

Admin User Stories:

• As an admin, I want to add custom links to the navbar so that my organization can easily access external/internal resources.
• As an admin, I want to limit the number of custom links to three to maintain a clean UI.
• As an admin, I want to enable or disable a link using an "Active" checkbox.
• As an admin, I want to define both the display text and the destination URL for each link.

General User Stories:

• As an org member, I want to see and use the custom links added by my admin.

4. Scope & Constraints

In-Scope:

• A section within Edit Organization where admins can:
  • Add/edit/delete up to three custom links.
  • Provide a name (display text) and URL for each link.
  • Mark links as Active or Inactive.
• Displaying the custom links at the bottom of the left navbar.
• Ensuring custom links are visible to all users but editable only by admins.
• Using the same icon library as existing navbar elements.

Out of Scope:

• Custom icons for links (icons will be chosen from the existing library).
• Per-user visibility settings (links are org-wide).
• Custom link ordering (links will appear in the order created).

5. UI/UX Considerations

• The Edit Organization screen should include a section for managing custom links.
• Each link should have:
  • A text field for the display name.
  • A text field for the URL.
  • An "Active" checkbox.
  • A delete button (available only if there are existing links).
• The navbar should display the custom links at the bottom, styled consistently with other items.
• If a link is marked Inactive, it should not appear in the navbar.

6. Technical Requirements

• Custom links should be stored in the database with fields for name, URL, active status, and created_at timestamp.
• The frontend should use the same icon library as existing navbar items.
• Validation:
  • URL must be a valid http:// or https:// link.
  • Display text should have a character limit (e.g., 30 characters).
  • Maximum three links per organization.
• Permissions:
  • Only admins can create/edit/delete links.
  • All org members can view and use the links.

7. Edge Cases & Considerations

• What happens if an admin adds three links and wants a fourth?
  • The UI should prevent adding more than three links.
• What happens if an admin disables a link?
  • It is removed from the navbar but remains in the settings for reactivation.
• What happens if a user enters an invalid URL?
  • The system should validate input before saving.
• What if an admin removes all links?
  • The navbar will not display a custom links section.

How to access the QA site

Login Details:
Link to QA site

Login Emails:

• volunteer1@example.com view site as a volunteer
• supervisor1@example.com view site as a supervisor
• casa_admin1@example.com view site as an admin
• all_casa_admin1@example.com view site as an all casa admin
  • go to /all_casa_admins/sign_in

password for all users: 12345678

Questions? Join Slack!

We highly recommend that you join us in slack #casa channel to ask questions quickly. And discord for office hours (currently Tuesday 5-7pm Pacific), stakeholder news, and upcoming new issues.