Skip to content

Commit

Permalink
feat: updated buttons to conform to install, update, enable and disab…
Browse files Browse the repository at this point in the history
…le (#1027)
  • Loading branch information
ssikande authored Jul 24, 2024
2 parents 77d38ef + a6f9c6d commit a6e73aa
Show file tree
Hide file tree
Showing 10 changed files with 1,272 additions and 1,188 deletions.
432 changes: 216 additions & 216 deletions lib/platform-bible-react/dist/index.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/platform-bible-react/dist/index.cjs.map

Large diffs are not rendered by default.

47 changes: 31 additions & 16 deletions lib/platform-bible-react/dist/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -988,39 +988,54 @@ export interface CharacterInventoryProps {
getText: (projectId: string, scriptureRef: ScriptureReference, scope: string) => Promise<string | undefined>;
}
export declare function CharacterInventory({ scriptureReference, setScriptureReference, localizedStrings, projectId, getSetting, setSetting, getText, }: CharacterInventoryProps): import("react/jsx-runtime").JSX.Element;
export type DownloadButtonProps = {
/** The downloading boolean value determines the state of the button. */
isDownloading: boolean;
export type InstallButtonProps = {
/** The installing boolean value determines the state of the button. */
isInstalling: boolean;
/** The handleClick function is called when the button is clicked. */
handleClick: () => void;
/** Optional text for the button. */
buttonText?: string;
};
/**
* The DownloadButton component is a button designed for initiating downloads. It includes visuals
* for active downloading and idle states.
* The InstallButton component is a button designed for initiating installs. It includes visuals for
* active installing and idle states.
*
* @param isDownloading The downloading boolean value determines the state of the button.
* @param isInstalling The installing boolean value determines the state of the button.
* @param handleClick The handleClick function is called when the button is clicked.
* @param buttonText Optional text for the button.
* @returns A download button.
* @returns A install button.
*/
export function DownloadButton({ isDownloading, handleClick, buttonText, }: DownloadButtonProps): import("react/jsx-runtime").JSX.Element;
export type RemoveButtonProps = {
/** The removing boolean value determines the state of the button. */
isRemoving: boolean;
export function InstallButton({ isInstalling, handleClick, buttonText, }: InstallButtonProps): import("react/jsx-runtime").JSX.Element;
export type EnableButtonProps = {
/** The enabling boolean value determines the state of the button. */
isEnabling: boolean;
/** The handleClick function is called when the button is clicked. */
handleClick: () => void;
};
/**
* The RemoveButton component is a button designed for initiating removals of downloads. It includes
* visuals for active removals and idle states.
* The EnableButton component is a button designed for initiating enabling of downloads. It includes
* visuals for active enabling and idle states.
*
* @param isRemoving The removing boolean value determines the state of the button.
* @param isEnabling The enabling boolean value determines the state of the button.
* @param handleClick The handleClick function is called when the button is clicked.
* @returns A button that can be used to remove.
* @returns A button that can be used to enable.
*/
export function RemoveButton({ isRemoving, handleClick }: RemoveButtonProps): import("react/jsx-runtime").JSX.Element;
export function EnableButton({ isEnabling, handleClick }: EnableButtonProps): import("react/jsx-runtime").JSX.Element;
export type DisableButtonProps = {
/** The disabling boolean value determines the state of the button. */
isDisabling: boolean;
/** The handleClick function is called when the button is clicked. */
handleClick: () => void;
};
/**
* The DisableButton component is a button designed for initiating disabling of downloads. It
* includes visuals for active disabling and idle states.
*
* @param isDisabling The disabling boolean value determines the state of the button.
* @param handleClick The handleClick function is called when the button is clicked.
* @returns A button that can be used to disable.
*/
export function DisableButton({ isDisabling, handleClick }: DisableButtonProps): import("react/jsx-runtime").JSX.Element;
export type UpdateButtonProps = {
/** The updating boolean value determines the state of the button. */
isUpdating: boolean;
Expand Down
Loading

0 comments on commit a6e73aa

Please sign in to comment.