@carbon/ibm-products
Version:
Carbon for IBM Products
66 lines • 1.96 kB
TypeScript
/**
* Copyright IBM Corp. 2021, 2025
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import React from 'react';
import PropTypes from 'prop-types';
interface APIKeyDownloaderProps {
/**
* the api key that's displayed to the user when a request to create is fulfilled.
*/
apiKey?: string;
/**
* the content that appears that indicates the key is downloadable
*/
body?: string;
/**
* designates the name of downloadable json file with the key. if not specified will default to 'apikey'
*/
fileName?: string;
/**
* designates the file type for the downloadable key
*/
fileType: 'txt' | 'json';
/**
* anchor text for the download link
*/
linkText: string;
/**
* Aria-label for the download link
*/
downloadLinkLabel: any;
}
export declare const APIKeyDownloader: {
(props: APIKeyDownloaderProps): React.JSX.Element;
displayName: string;
propTypes: {
/**
* the api key that's displayed to the user when a request to create is fulfilled.
*/
apiKey: PropTypes.Validator<string>;
/**
* body content for the downloader
*/
body: PropTypes.Requireable<string>;
/**
* aria-label for the download link
*/
downloadLinkLabel: PropTypes.Requireable<string>;
/**
* designates the name of downloadable json file with the key. if not specified will default to 'apikey'
*/
fileName: PropTypes.Validator<string>;
/**
* designates the file type for the downloadable key
*/
fileType: PropTypes.Validator<string>;
/**
* anchor text for the download link
*/
linkText: PropTypes.Validator<string>;
};
};
export {};
//# sourceMappingURL=APIKeyDownloader.d.ts.map