@atlaskit/logo/report.api.md

A logo is a visual representation of a brand or product. It can be a word or an image, or a combination of both.

<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/logo"

> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)

### Table of contents

- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)

### Main Entry Types

<!--SECTION START: Main Entry Types-->

```ts
/// <reference types="react" />

// @public (undocumented)
type Appearance = 'brand' | 'inverse' | 'neutral';

// @public
export const AtlasIcon: ({
	appearance,
	label,
	size,
	testId,
}: LogoPropsAppearanceRequired) => JSX.Element;

// @public
export const AtlasLogo: ({
	appearance,
	label,
	size,
	testId,
}: LogoPropsAppearanceRequired) => JSX.Element;

// @public
export const AtlassianAnalyticsIcon: ({
	appearance,
	label,
	size,
	testId,
}: LogoPropsAppearanceRequired) => JSX.Element;

// @public
export const AtlassianAnalyticsLogo: ({
	appearance,
	label,
	size,
	testId,
}: LogoPropsAppearanceRequired) => JSX.Element;

// @public
export const AtlassianIcon: ({
	appearance,
	label,
	size,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
	testId,
}: LogoProps) => JSX.Element;

// @public
export const AtlassianLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const AtlassianStartLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const AtlassianWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const BitbucketIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const BitbucketLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const BitbucketWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const CompassIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const CompassLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const CompassWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const ConfluenceIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const ConfluenceLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const ConfluenceWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const HalpIcon: ({
	appearance,
	label,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public
export const HalpLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const HalpWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const HipchatIcon: ({
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const HipchatLogo: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const HipchatWordmark: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraAlignIcon: ({
	appearance,
	label,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public
export const JiraAlignLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraAlignWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const JiraCoreIcon: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const JiraCoreLogo: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const JiraCoreWordmark: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraIcon: ({
	appearance,
	label,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public
export const JiraLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraProductDiscoveryIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraProductDiscoveryLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const JiraServiceDeskIcon: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const JiraServiceDeskLogo: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const JiraServiceDeskWordmark: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraServiceManagementIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraServiceManagementLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraServiceManagementWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraSoftwareIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraSoftwareLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraSoftwareWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public
export const JiraWordmark: ({
	appearance,
	label,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraWorkManagementIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraWorkManagementLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const JiraWorkManagementWordmark: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public (undocumented)
export type LogoProps = {
	size?: Size;
	appearance?: Appearance;
	textColor?: string;
	iconColor?: string;
	iconGradientStart?: string;
	iconGradientStop?: string;
	label?: string;
	testId?: string;
};

// @public (undocumented)
type LogoPropsAppearanceRequired = Omit<
	WithRequiredProperty<LogoProps, 'appearance'>,
	'iconColor' | 'iconGradientStart' | 'iconGradientStop' | 'textColor'
>;

// @public @deprecated (undocumented)
export const OpsGenieIcon: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const OpsgenieIcon: ({
	appearance,
	label,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const OpsGenieLogo: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const OpsgenieLogo: ({
	appearance,
	label,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const OpsGenieWordmark: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const OpsgenieWordmark: ({
	appearance,
	size,
	testId,
	textColor,
	iconColor,
	iconGradientStart,
	iconGradientStop,
}: LogoProps) => JSX.Element;

// @public (undocumented)
type Size = 'large' | 'medium' | 'small' | 'xlarge' | 'xsmall';

// @public
export const StatuspageIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const StatuspageLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const StatuspageWordmark: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const StrideIcon: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const StrideLogo: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public @deprecated (undocumented)
export const StrideWordmark: ({
	iconColor,
	iconGradientStart,
	iconGradientStop,
	size,
	testId,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const TrelloIcon: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const TrelloLogo: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
export const TrelloWordmark: ({
	appearance,
	label,
	size,
	testId,
	iconColor,
	iconGradientStart,
	iconGradientStop,
	textColor,
}: LogoProps) => JSX.Element;

// @public
type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
	[Property in Key]-?: Type[Property];
};

// (No @packageDocumentation comment for this package)
```

<!--SECTION END: Main Entry Types-->

### Peer Dependencies

<!--SECTION START: Peer Dependencies-->

```json
{
	"react": "^16.8.0"
}
```

<!--SECTION END: Peer Dependencies-->