mirror of
https://github.com/UofCBaja/BajaUofCWebsite.git
synced 2025-06-15 13:24:17 -06:00
docs(header): changed js docs to make more sense
This commit is contained in:
parent
cffb9f46e6
commit
654ca434d8
@ -6,7 +6,7 @@ import Ender from "../Footer/Ender";
|
||||
import { useEffect, useState } from "react";
|
||||
|
||||
/**
|
||||
* @param {useOutletContext} dict - List of items to display as the banner, more detals in UpdateBanner.jsx
|
||||
* @param {null} nothing - Takes in nothing
|
||||
* @returns {JSX.Element} JSX - HTML tags and JS functionality
|
||||
* @description The top header part of the page includes the naviagtion
|
||||
* @author Brock <darkicewolf50@gmail.com>
|
||||
|
@ -6,6 +6,7 @@ import { useOutletContext } from "react-router-dom";
|
||||
* @param {String} subtitleText - The text below the banner text you want
|
||||
* @param {String} imgUrl - The url to the image you want as the banner, by default this will be a lorem picsum
|
||||
* @param {String} imgAlt - The alt text for the image banner, this is required for good search results
|
||||
* @param {useOutletContext} dict - List of items to display as the banner, more detals in UpdateBanner.jsx
|
||||
* @description The way to update the banner from the child
|
||||
* @example ```js
|
||||
RouteComponent {
|
||||
|
Loading…
x
Reference in New Issue
Block a user