RESTfulMC/Frontend/src/app/types/config.d.ts
Rainnny7 f1cd72e8b3
Some checks failed
Deploy Frontend / docker (17, 3.8.5) (push) Has been cancelled
wow a footer!
2024-04-18 20:12:25 -04:00

103 lines
1.5 KiB
TypeScript

import { Metadata, Viewport } from "next";
/**
* Options for configuration.
*/
interface Config {
/**
* The name of this site.
*/
siteName: string;
/**
* The URL of this site.
*/
siteUrl: string;
/**
* The endpoint of the API.
*/
apiEndpoint: string;
/**
* The optional domain to track analytics on.
*/
analyticsDomain: string | undefined;
/**
* The metadata of this site.
*/
metadata: Metadata;
/**
* The viewport of this site.
*/
viewport: Viewport;
/**
* Links to display on the navbar.
* <p>
* The key is the name of the
* link, and the value is the URL.
* </p>
*/
navbarLinks: NavbarLink;
/**
* Featured items for the landing page.
*/
featuredItems: FeaturedItemProps[];
/**
* Links to display on the footer.
*/
footerLinks: FooterLink;
}
/**
* The links for the navbar.
*/
type NavbarLinks = {
[name: string]: string;
};
/**
* Links for the footer.
*/
type FooterLinks = {
[header: string]: FooterLink;
};
/**
* A link on the footer.
*/
type FooterLink = {
[name: string]: string;
};
/**
* Props for a featured item
* on the landing page.
*/
type FeaturedItemProps = {
/**
* The name of this item.
*/
name: string;
/**
* The description of this item.
*/
description: string;
/**
* The image for this item.
*/
image: string;
/**
* The href link for this item.
*/
href: string;
};