v3: src/ is documented like api/ and shared/, and the reference covers the whole repository — the frontend had no module docs, JSDoc on some components and hooks and not on others, props typed inline in half the components and in private interfaces in the rest, // comments on declarations, and no return types on 147 exported functions, so deno doc --lint over src/ found 637 errors. The rule api/ follows is applied to every non-test module of src/: a /** … @module */ block, JSDoc on every export and every field of an exported interface, /** */ for declarations and // for notes, verbs for functions ("Renders…" for a component), parameters named in the prose, {@link} only for symbols in scope, and a page's JSDoc names its route and who may see it (App.tsx's module doc lists the route table). For deno doc to show them, every exported function states its return type: components React.JSX.Element (or | null, or a portal), memo and forwardRef components their exotic types, contexts React.Context<…>, and a hook returning several things a documented Use<Name>Result interface (useAuth, useRequiredAuth, useFading, useEmojiTrigger, useMentionAutocomplete, useDumpCardLink, usePlayRichContent; FeedCacheResult, YouTubePlaylistControls and UseApiFormReturn are renamed to match). Every component that takes props takes an exported, documented <Name>Props interface — the 64 inline prop types are lifted into one, DumpFeed gets DumpFeedProps extending MainFeedProps. React types go through the global React namespace: the four default imports of react are gone, since deno doc can't follow them. Two duplicates go too: useMentionAutocomplete's UserResult was shared/'s UserSuggestion, and JournalCard re-exported JournalShape for no one; i18n.ts no longer re-exports Lingui's i18n, which its three users now import from @lingui/core. deno task doc and doc:lint now take src/ (but its tests and the generated locales), the index page gains a Frontend section linking every module by layer and domain, mod.test.ts walks src/ as well, and the docs workflow runs on changes to src/. deno doc doesn't document npm packages, so it takes a type imported from one — react-hook-form's FieldValues in the form fields, frimousse's SkinTone — for a private one; doc:lint now goes through doc-lint.ts, which fails on every diagnostic but those, 25 of them. The README states the frontend's part of the rule. No behaviour changes; 205 backend and 628 frontend tests pass, and tsc, deno check and deno lint are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,16 +1,34 @@
|
||||
/**
|
||||
* An image that is also its own upload button.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
import { useRef } from "react";
|
||||
|
||||
interface ImagePickerProps {
|
||||
/** The props of {@link ImagePicker}. */
|
||||
export interface ImagePickerProps {
|
||||
/** The current image, null without one. */
|
||||
src: string | null;
|
||||
/** Its alt text. */
|
||||
alt?: string;
|
||||
/** The side, in px; 80 by default. */
|
||||
size?: number;
|
||||
/** The corner radius, in px; 8 by default. */
|
||||
borderRadius?: number;
|
||||
/** Called with the file picked. */
|
||||
onChange: (file: File) => void;
|
||||
/** Whether an upload is under way: the picker is disabled meanwhile. */
|
||||
uploading?: boolean;
|
||||
/** The file types offered; JPEG, PNG, GIF and WebP by default. */
|
||||
accept?: string;
|
||||
/** An extra class. */
|
||||
className?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders an image (or a placeholder) that opens a file picker when clicked.
|
||||
*/
|
||||
export function ImagePicker({
|
||||
src,
|
||||
alt = "",
|
||||
@@ -20,7 +38,7 @@ export function ImagePicker({
|
||||
uploading = false,
|
||||
accept = "image/jpeg,image/png,image/gif,image/webp",
|
||||
className,
|
||||
}: ImagePickerProps) {
|
||||
}: ImagePickerProps): React.JSX.Element {
|
||||
const inputRef = useRef<HTMLInputElement>(null);
|
||||
const sizeStyle = { width: size, height: size, borderRadius };
|
||||
|
||||
|
||||
Reference in New Issue
Block a user