jsx-readme/lib/components/BadgesFromPkg.d.ts

Generate Readme files with a React-like syntax and package.json-aware helpers.

import type { Component } from "jsx-md";
import type { PackageJSON } from "../PackageJSON";
/** @internal */
interface Props {
    disabledBadges?: ReadonlyArray<BadgeName>;
    pkg: Readonly<PackageJSON>;
}
/** @internal */
export declare const badgeComponents: {
    readonly npmVersion: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly npmDownloads: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly npmBundleSize: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly dependenciesBadge: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly devDependenciesBadge: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly githubTopLanguageBadge: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly githubIssues: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly jsxReadme: Component;
    readonly semanticRelease: import("./badges/utils/BadgeComponent").BadgeComponent;
    readonly hits: import("./badges/utils/BadgeComponent").BadgeComponent;
};
type BadgeName = keyof typeof badgeComponents;
/** @internal */
export declare const defaultBadges: ReadonlyArray<BadgeName>;
/** Renders a list of badges that can be inferred from `package.json`. */
export declare const BadgesFromPkg: Component<Readonly<Props>>;
export {};