@atlaskit/logo 13.7.1 → 13.8.2

package/report.api.md

@@ -0,0 +1,606 @@
+## API Report File for "@atlaskit/logo"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+export declare const AtlassianIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  textColor,
+  testId,
+}: LogoProps) => JSX.Element;
+
+export declare const AtlassianLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const AtlassianStartLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const AtlassianWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const BitbucketIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const BitbucketLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const BitbucketWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const CompassIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const CompassLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const CompassWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const ConfluenceIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const ConfluenceLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const ConfluenceWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const HalpIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const HalpLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const HalpWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated HipchatIcon will be removed from @atlaskit/logo in the next major release.
+ */
+export declare const HipchatIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated HipchatLogo will be removed from @atlaskit/logo in the next major release.
+ */
+export declare const HipchatLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated HipchatWordmark will be removed from @atlaskit/logo in the next major release.
+ */
+export declare const HipchatWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated JiraCoreIcon will be removed from @atlaskit/logo in the next major release. Please use JiraWorkManagementIcon instead.
+ */
+export declare const JiraCoreIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated JiraCoreLogo will be removed from @atlaskit/logo in the next major release. Please use JiraWorkManagementLogo instead.
+ */
+export declare const JiraCoreLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated JiraCoreWordmark will be removed from @atlaskit/logo in the next major release. Please use JiraWorkManagementWordmark instead.
+ */
+export declare const JiraCoreWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated JiraServiceDeskIcon will be removed from atlaskit/logo in the next major release. Please use JiraServiceManagementIcon instead.
+ */
+export declare const JiraServiceDeskIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated JiraServiceDeskLogo will be removed from atlaskit/logo in the next major release. Please use JiraServiceManagementLogo instead.
+ */
+export declare const JiraServiceDeskLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated JiraServiceDeskWordmark will be removed from atlaskit/logo in the next major release. Please use JiraServiceManagementWordmark instead.
+ */
+export declare const JiraServiceDeskWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraServiceManagementIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraServiceManagementLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraServiceManagementWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraSoftwareIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraSoftwareLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraSoftwareWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraWorkManagementIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraWorkManagementLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const JiraWorkManagementWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare type LogoProps = {
+  /**
+   * The size of the icon, uses the same sizing scheme as in `@atlaskit/icon`.
+   */
+  size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
+  /**
+   * CSS color to be applied to the wordmark portion of the logo SVG.
+   */
+  textColor?: string;
+  /**
+   * CSS color to be applied to the non-gradient icon portion of the logo SVG.
+   */
+  iconColor?: string;
+  /**
+   * CSS color to start the gradient/shadow on the icon.
+   */
+  iconGradientStart?: string;
+  /**
+   * CSS color to end the gradient/shadow on the icon. Should usually match iconColor to avoid
+   * rendering issues in some browsers such as Safari.
+   */
+  iconGradientStop?: string;
+  /**
+   * Accessible text to be used for screen readers (it's optional since defaultProps contains empty string for it).
+   */
+  label?: string;
+  /**
+   * A testId prop is provided for specified elements, which is a unique string that appears as a data attribute data-testid in the rendered code, serving as a hook for automated tests.
+   * - `{testId}--wrapper` to access the svg element's wrapper
+   */
+  testId?: string;
+};
+
+/**
+ * @deprecated OpsGenieIcon is incorrectly cased and will be removed from atlaskit/logo in the next major release. Please use OpsgenieIcon (no capital 'g') instead.
+ */
+export declare const OpsGenieIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * This is the correct seplling of Opsgenie and the icon we are moving towards after OpsGenie is deprecated correctly.
+ */
+export declare const OpsgenieIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated OpsGenieLogo is incorrectly cased and will be removed from atlaskit/logo in the next major release. Please use OpsgenieLogo (no capital 'g') instead.
+ */
+export declare const OpsGenieLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * This is the correct logo as it has the correct casing. Please do not use old-logo.tsx.
+ */
+export declare const OpsgenieLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated OpsGenieWordmark is incorrectly cased and will be removed from atlaskit/logo in the next major release. Please use OpsgenieLogo (no capital 'g') instead.
+ */
+export declare const OpsGenieWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const OpsgenieWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const StatuspageIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const StatuspageLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const StatuspageWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated StrideIcon will be removed from atlaskit/logo in the next major release.
+ */
+export declare const StrideIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated StrideLogo will be removed from atlaskit/logo in the next major release.
+ */
+export declare const StrideLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+/**
+ * @deprecated StrideWordmark will be removed from atlaskit/logo in the next major release.
+ */
+export declare const StrideWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const TrelloIcon: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const TrelloLogo: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export declare const TrelloWordmark: ({
+  iconColor,
+  iconGradientStart,
+  iconGradientStop,
+  label,
+  size,
+  testId,
+  textColor,
+}: LogoProps) => JSX.Element;
+
+export {};
+```