Skip to content

Add TypeScript type annotations for improved type safety #4511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Simek merged 12 commits into from
Oct 9, 2025
Merged

Add TypeScript type annotations for improved type safety #4511

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
af6f08a
Add TypeScript type annotations to components for improved type safety
clicktodev Feb 16, 2025
361ba8a
Refactor UserAppType definition for improved type inference
clicktodev Feb 16, 2025
9fe57d3
Refactor InlineCode component to enhance linkify function type safety
clicktodev Feb 16, 2025
667af81
Add TypeScript type annotations to PlatformSupport component for impr…
clicktodev Feb 16, 2025
0614f49
Add TypeScript type annotations to DocVersionBanner components for im…
clicktodev Feb 16, 2025
e493a60
Refactor AppBox component to simplify infoLink condition
clicktodev Feb 16, 2025
09c3f45
Refactor components to improve type safety and simplify props usage
clicktodev Feb 18, 2025
7dedc60
Add TypeScript type annotation to commonDocsOptions for improved type…
clicktodev Mar 18, 2025
72c70dd
Update import syntax in .remarkrc.mjs for compatibility with new JSON…
clicktodev Mar 18, 2025
083d963
Merge branch 'main' into better-types
clicktodev Oct 9, 2025
c4949f6
undo
clicktodev Oct 9, 2025
47277b7
Update website/src/components/Home/Section/index.tsx
Simek Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export type EditUrlButton = {
href: string;
};

const commonDocsOptions = {
const commonDocsOptions: PluginContentDocs.Options = {
breadcrumbs: false,
showLastUpdateAuthor: false,
showLastUpdateTime: true,
Expand Down
2 changes: 1 addition & 1 deletion website/src/components/Home/Platforms/FoxFact.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import React from 'react';

function FoxFact({className}) {
function FoxFact({className}: {className: string}) {
return (
<svg
width={167}
Expand Down
2 changes: 1 addition & 1 deletion website/src/components/Home/Section/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import React from 'react';

import styles from './styles.module.css';

function Section({children}) {
function Section({children}: {children: React.ReactNode}) {
Comment thread
Simek marked this conversation as resolved.
Outdated
return (
<div className={styles.wrapper}>
<div className={styles.container}>{children}</div>
Expand Down
16 changes: 10 additions & 6 deletions website/src/pages/showcase.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ import type users from '../../showcase.json';
import IconExternalLink from '../theme/Icon/ExternalLink';
import ThemedImage from '@theme/ThemedImage';

const renderApp = (app, i) => <AppBox app={app} key={`app-${app.name}-${i}`} />;
type UserAppType = (typeof users)[keyof typeof users][number];

const renderApp = (app: UserAppType, i: number) => (
<AppBox app={app} key={`app-${app.name}-${i}`} />
);

function Section({
children,
Expand All @@ -22,7 +26,7 @@ function Section({
return <section className={`Section ${background}`}>{children}</section>;
}

const AppBox = ({app}) => {
const AppBox = ({app}: {app: UserAppType}) => {
const imgSource = useBaseUrl(
app.icon.startsWith('http') ? app.icon : 'img/showcase/' + app.icon
);
Expand All @@ -38,7 +42,7 @@ const AppBox = ({app}) => {
<h3>{app.name}</h3>
{renderLinks(app)}
</div>
{app.infoLink && (
{'infoTitle' in app && app.infoLink && (
<a
className="articleButton"
href={app.infoLink}
Expand All @@ -53,7 +57,7 @@ const AppBox = ({app}) => {
);
};

const renderLinks = app => {
const renderLinks = (app: UserAppType) => {
const links = [
app.linkAppStore ? (
<a key="ios" href={app.linkAppStore} target="_blank">
Expand All @@ -65,12 +69,12 @@ const renderLinks = app => {
Android
</a>
) : null,
app.linkDesktop ? (
'linkDesktop' in app && app.linkDesktop ? (
<a key="desktop" href={app.linkDesktop} target="_blank">
Desktop
</a>
) : null,
app.linkMetaQuest ? (
'linkMetaQuest' in app && app.linkMetaQuest ? (
<a key="quest" href={app.linkMetaQuest} target="_blank">
Meta&nbsp;Quest
</a>
Expand Down