forked/topola-viewer
1
0
Fork 0
mirror of https://github.com/PeWu/topola-viewer.git synced 2026-07-22 03:31:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Format markdown files

Browse Source
This commit is contained in:
Przemek Więch
2026-07-05 22:51:04 +02:00
parent 72abbc7e7e
commit 85df7d13bb
27 changed files with 3602 additions and 1541 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/util/README.md
View File

@@ -1,17 +1,35 @@
# Utilities (`src/util`)
This directory contains various utility functions, hooks, and classes used across the application. These utilities handle date calculations, GEDCOM data processing, internationalization of errors, analytics, and responsive design setup.
This directory contains various utility functions, hooks, and classes used
across the application. These utilities handle date calculations, GEDCOM data
processing, internationalization of errors, analytics, and responsive design
setup.
## Files
- **[age_util.ts](age_util.ts)**: Utilities for calculating and formatting age based on birth and death dates. It handles exact dates, ranges, and qualifiers, and supports localization.
- **[age_util.ts](age_util.ts)**: Utilities for calculating and formatting age
based on birth and death dates. It handles exact dates, ranges, and
qualifiers, and supports localization.
- **[age_util.spec.ts](age_util.spec.ts)**: Unit tests for `age_util.ts`.
- **[analytics.ts](analytics.ts)**: Provides the `analyticsEvent` function to send events to Google Analytics using `gtag`.
- **[analytics_noop.ts](analytics_noop.ts)**: A no-op implementation of `analyticsEvent`, used when analytics are disabled.
- **[date_util.ts](date_util.ts)**: Utilities for formatting and comparing dates, handling `DateOrRange` objects from the `topola` library, and supporting localization.
- **[error.ts](error.ts)**: Defines the `TopolaError` class, extending `Error` to include an error code and arguments used for internationalized error messages.
- **[error_i18n.ts](error_i18n.ts)**: Provides `getI18nMessage` to return translated messages for `TopolaError` instances.
- **[gedcom_util.ts](gedcom_util.ts)**: A comprehensive utility file for handling GEDCOM data. It includes functions for parsing and converting GEDCOM files, normalizing data (sorting children and spouses), dereferencing entries, and extracting specific data like names and sources.
- **[gedcom_util.spec.ts](gedcom_util.spec.ts)**: Unit tests for `gedcom_util.ts`.
- **[media.ts](media.ts)**: Sets up responsive design breakpoints (small and large) using the `@artsy/fresnel` library.
- **[previous-hook.ts](previous-hook.ts)**: A custom React hook (`usePrevious`) that returns the value of a variable from the previous render.
- **[analytics.ts](analytics.ts)**: Provides the `analyticsEvent` function to
send events to Google Analytics using `gtag`.
- **[analytics_noop.ts](analytics_noop.ts)**: A no-op implementation of
`analyticsEvent`, used when analytics are disabled.
- **[date_util.ts](date_util.ts)**: Utilities for formatting and comparing
dates, handling `DateOrRange` objects from the `topola` library, and
supporting localization.
- **[error.ts](error.ts)**: Defines the `TopolaError` class, extending `Error`
to include an error code and arguments used for internationalized error
messages.
- **[error_i18n.ts](error_i18n.ts)**: Provides `getI18nMessage` to return
translated messages for `TopolaError` instances.
- **[gedcom_util.ts](gedcom_util.ts)**: A comprehensive utility file for
handling GEDCOM data. It includes functions for parsing and converting GEDCOM
files, normalizing data (sorting children and spouses), dereferencing entries,
and extracting specific data like names and sources.
- **[gedcom_util.spec.ts](gedcom_util.spec.ts)**: Unit tests for
`gedcom_util.ts`.
- **[media.ts](media.ts)**: Sets up responsive design breakpoints (small and
large) using the `@artsy/fresnel` library.
- **[previous-hook.ts](previous-hook.ts)**: A custom React hook (`usePrevious`)
that returns the value of a variable from the previous render.