Files
2024-02-15 17:01:50 +00:00

127 lines
3.5 KiB
TypeScript

import type {ComponentProps} from 'react';
import {Fragment} from 'react';
import styled from '@emotion/styled';
import HookOrDefault from 'sentry/components/hookOrDefault';
import ExternalLink from 'sentry/components/links/externalLink';
import List from 'sentry/components/list';
import ListItem from 'sentry/components/list/listItem';
import {AuthTokenGeneratorProvider} from 'sentry/components/onboarding/gettingStartedDoc/authTokenGenerator';
import type {StepProps} from 'sentry/components/onboarding/gettingStartedDoc/step';
import {Step} from 'sentry/components/onboarding/gettingStartedDoc/step';
import type {NextStep} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {PlatformOptionsControl} from 'sentry/components/onboarding/platformOptionsControl';
import {ProductSelection} from 'sentry/components/onboarding/productSelection';
import {t} from 'sentry/locale';
import {space} from 'sentry/styles/space';
import type {PlatformKey} from 'sentry/types';
import useOrganization from 'sentry/utils/useOrganization';
const ProductSelectionAvailabilityHook = HookOrDefault({
hookName: 'component:product-selection-availability',
defaultComponent: ProductSelection,
});
export type LayoutProps = {
projectSlug: string;
steps: StepProps[];
/**
* An introduction displayed before the steps
*/
introduction?: React.ReactNode;
newOrg?: boolean;
nextSteps?: NextStep[];
platformKey?: PlatformKey;
platformOptions?: ComponentProps<typeof PlatformOptionsControl>['platformOptions'];
};
export function Layout({
steps,
platformKey,
newOrg,
nextSteps = [],
platformOptions,
introduction,
projectSlug,
}: LayoutProps) {
const organization = useOrganization();
return (
<AuthTokenGeneratorProvider projectSlug={projectSlug}>
<Wrapper>
<Header>
{introduction && <Introduction>{introduction}</Introduction>}
<ProductSelectionAvailabilityHook
organization={organization}
platform={platformKey}
/>
{platformOptions ? (
<PlatformOptionsControl platformOptions={platformOptions} />
) : null}
</Header>
<Divider withBottomMargin={newOrg} />
<Steps>
{steps.map(step => (
<Step key={step.title ?? step.type} {...step} />
))}
</Steps>
{nextSteps.length > 0 && (
<Fragment>
<Divider />
<h4>{t('Next Steps')}</h4>
<List symbol="bullet">
{nextSteps.map(step => (
<ListItem key={step.name}>
<ExternalLink href={step.link}>{step.name}</ExternalLink>
{': '}
{step.description}
</ListItem>
))}
</List>
</Fragment>
)}
</Wrapper>
</AuthTokenGeneratorProvider>
);
}
const Header = styled('div')`
display: flex;
flex-direction: column;
gap: ${space(2)};
`;
const Divider = styled('hr')<{withBottomMargin?: boolean}>`
height: 1px;
width: 100%;
background: ${p => p.theme.border};
border: none;
${p => p.withBottomMargin && `margin-bottom: ${space(3)}`}
`;
const Steps = styled('div')`
display: flex;
flex-direction: column;
gap: 1.5rem;
`;
const Introduction = styled('div')`
display: flex;
flex-direction: column;
gap: ${space(1)};
`;
const Wrapper = styled('div')`
h4 {
margin-bottom: 0.5em;
}
&& {
p {
margin-bottom: 0;
}
h5 {
margin-bottom: 0;
}
}
`;