chore: add js-doc (#275)

This commit is contained in:
doprz
2024-10-07 23:06:35 -05:00
committed by GitHub
parent 668c8d0075
commit b3632c0196
7 changed files with 22 additions and 5 deletions

View File

@@ -2,7 +2,7 @@ import Text from '@views/components/common/Text/Text';
import React from 'react';
/**
* A type that represents the flags that a course can have.
* A type that represents the flags that a course can have
*/
export type Flag = 'WR' | 'QR' | 'GC' | 'CD' | 'E' | 'II';
export const flagMap = {

View File

@@ -13,6 +13,9 @@ import React, { Fragment } from 'react';
import ExtensionRoot from './ExtensionRoot/ExtensionRoot';
/**
* Represents the props for the _Dialog component
*/
export interface _DialogProps {
className?: string;
title?: JSX.Element;

View File

@@ -7,6 +7,10 @@ import Dialog from '../Dialog';
import Text from '../Text/Text';
type DialogElement = (show: boolean) => ReactNode;
/**
* Represents information for a prompt dialog
*/
export interface PromptInfo extends Omit<DialogInfo, 'buttons' | 'className' | 'title' | 'description'> {
title: JSX.Element | string;
description: JSX.Element | string;