From 04ce12eeecc95fc1323343a685961cbef28eae9f Mon Sep 17 00:00:00 2001 From: Christian Jaeger Date: Sun, 9 Feb 2025 00:05:45 +0100 Subject: [PATCH 1/2] docs: document some functions and modules, add some return types -- unfinished --- website/src/types/Organism.ts | 4 ++++ website/src/types/dataOrigins.ts | 4 ++++ website/src/views/OrganismConstants.ts | 15 +++++++++++++-- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/website/src/types/Organism.ts b/website/src/types/Organism.ts index 0f7d2d31..7b39a4b4 100644 --- a/website/src/types/Organism.ts +++ b/website/src/types/Organism.ts @@ -1,3 +1,7 @@ +/** + * Identification, basic styling (full name) and page styling information for an organism. + */ + import { z } from 'zod'; export const Organisms = { diff --git a/website/src/types/dataOrigins.ts b/website/src/types/dataOrigins.ts index d69fcd6a..38fd7679 100644 --- a/website/src/types/dataOrigins.ts +++ b/website/src/types/dataOrigins.ts @@ -1,3 +1,7 @@ +/** + * Available data sources for data on an organism + */ + export const dataOrigins = { insdc: 'insdc' as const, pathoplexus: 'pathoplexus' as const, diff --git a/website/src/views/OrganismConstants.ts b/website/src/views/OrganismConstants.ts index 787b4196..4cda5035 100644 --- a/website/src/views/OrganismConstants.ts +++ b/website/src/views/OrganismConstants.ts @@ -5,9 +5,14 @@ import type { LineageFilterConfig } from '../components/pageStateSelectors/Linea import type { Organism } from '../types/Organism.ts'; import type { DataOrigin } from '../types/dataOrigins.ts'; +/** + * Organism constants are values describing an organism, that are then used as parameters for setting up + * a view for that organism (XX how?). + */ export interface OrganismConstants { readonly organism: Organism; readonly dataOrigins: DataOrigin[]; + /** XX what is this? */ readonly accessionDownloadFields: string[]; } @@ -16,12 +21,18 @@ export const ComponentHeight = { small: '300px', } as const; +/** + * XX, used in mbox and westNile views + */ export interface AdditionalSequencingEffortsField { readonly label: string; readonly fields: string[]; readonly height: (typeof ComponentHeight)[keyof typeof ComponentHeight]; } +/** + * XX, used in all(?) views + */ export interface ExtendedConstants extends OrganismConstants { readonly locationFields: string[]; readonly mainDateField: string; @@ -36,7 +47,7 @@ export interface ExtendedConstants extends OrganismConstants { export function getAuthorRelatedSequencingEffortsFields(constants: { authorsField: string | undefined; authorAffiliationsField: string | undefined; -}) { +}): AdditionalSequencingEffortsField[] { const authorAffiliations = constants.authorAffiliationsField === undefined ? [] @@ -62,7 +73,7 @@ export function getAuthorRelatedSequencingEffortsFields(constants: { export function getPathoplexusAdditionalSequencingEffortsFields( constants: Parameters[0], -) { +): AdditionalSequencingEffortsField[] { return [ { label: 'Pathoplexus submitting groups', From a2359789b09b4ab26f31f141464f101f3ba27728 Mon Sep 17 00:00:00 2001 From: Christian Jaeger Date: Thu, 6 Feb 2025 10:39:05 +0100 Subject: [PATCH 2/2] -components.md --- website/docs/components.md | 315 +++++++++++++++++++++++++++++++++++++ 1 file changed, 315 insertions(+) create mode 100644 website/docs/components.md diff --git a/website/docs/components.md b/website/docs/components.md new file mode 100644 index 00000000..4ca7efb4 --- /dev/null +++ b/website/docs/components.md @@ -0,0 +1,315 @@ +# Components + +## React components + +* `src/components/ErrorReportInstruction.tsx` + + - ErrorReportToastModal + - ErrorReportInstruction + - CopyToClipboardButton + +* `src/components/auth/LoginButton.tsx` + + - LoginButton: `