Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

6.1 KB
Raw Blame
import { useMountedLogic } from 'kea'
import { forwardRef } from 'react'

import { exportsLogic } from 'lib/components/ExportButton/exportsLogic'
import { LemonButton, LemonButtonProps, LemonButtonWithDropdown } from 'lib/lemon-ui/LemonButton'
import { LemonDivider } from 'lib/lemon-ui/LemonDivider'
import { getAccessControlDisabledReason } from 'lib/utils/accessControlUtils'

import { AccessControlLevel, AccessControlResourceType, ExporterFormat, OnlineExportContext } from '~/types'

import { TriggerExportProps } from './exporter'

export interface ExportButtonItem {
    title?: string | React.ReactNode
    export_format: ExporterFormat
    export_context?: TriggerExportProps['export_context']
    dashboard?: number
    insight?: number
}

/** A client-side copy action rendered in a "Copy to clipboard" section below the export formats. */
export interface ExportButtonCopyToClipboardItem {
    title: string
    onClick: () => void
    disabledReason?: string
    'data-attr'?: string
}

export interface ExportButtonProps extends Pick<
    LemonButtonProps,
    'disabledReason' | 'icon' | 'sideIcon' | 'id' | 'type' | 'fullWidth'
> {
    items: ExportButtonItem[]
    copyToClipboardItems?: ExportButtonCopyToClipboardItem[]
    buttonCopy?: string
    size?: LemonButtonProps['size']
}

export const ExportButton: React.FunctionComponent<ExportButtonProps & React.RefAttributes<HTMLButtonElement>> =
    forwardRef(function ExportButton({ items, copyToClipboardItems, buttonCopy, ...buttonProps }, ref): JSX.Element {
        useMountedLogic(exportsLogic)

        const { actions } = exportsLogic
        const onExportClick = async (triggerExportProps: TriggerExportProps): Promise<void> => {
            actions.startExport(triggerExportProps)
        }

        // Creating an export requires editor access to the export resource.
        const accessControlDisabledReason = getAccessControlDisabledReason(
            AccessControlResourceType.Export,
            AccessControlLevel.Editor
        )

        return (
            <LemonButtonWithDropdown
                ref={ref}
                data-attr="export-button"
                {...buttonProps}
                disabledReason={buttonProps.disabledReason ?? accessControlDisabledReason ?? undefined}
                dropdown={{
                    actionable: true,
                    placement: 'right-start',
                    closeParentPopoverOnClickInside: true,
                    overlay: (
                        <>
                            <h5>File type</h5>
                            <LemonDivider />
                            {items.map(({ title, ...triggerExportProps }, i) => {
                                const exportFormatExtension = (
                                    Object.keys(ExporterFormat).find(
                                        (key) =>
                                            ExporterFormat[key as keyof typeof ExporterFormat] ===
                                            triggerExportProps.export_format
                                    ) ?? triggerExportProps.export_format
                                ).toLowerCase()

                                let target: string
                                let exportBody: string = ''
                                if (triggerExportProps.insight) {
                                    target = `insight-${triggerExportProps.insight}`
                                } else if (triggerExportProps.dashboard) {
                                    target = `dashboard-${triggerExportProps.dashboard}`
                                } else if ('path' in (triggerExportProps.export_context || {})) {
                                    target =
                                        (triggerExportProps.export_context as OnlineExportContext)?.path || 'unknown'
                                    exportBody =
                                        (triggerExportProps.export_context as OnlineExportContext)?.body || 'unknown'
                                } else {
                                    target = 'unknown'
                                }

                                return (
                                    <LemonButton
                                        key={i}
                                        fullWidth
                                        onClick={() => void onExportClick(triggerExportProps)}
                                        data-attr={`export-button-${exportFormatExtension}`}
                                        data-ph-capture-attribute-export-target={target}
                                        data-ph-capture-attribute-export-body={
                                            exportBody.length ? JSON.stringify(exportBody) : null
                                        }
                                    >
                                        {title ? title : `.${exportFormatExtension}`}
                                    </LemonButton>
                                )
                            })}
                            {copyToClipboardItems && copyToClipboardItems.length > 0 ? (
                                <>
                                    <h5 className="mt-2">Copy to clipboard</h5>
                                    <LemonDivider />
                                    {copyToClipboardItems.map((item, i) => (
                                        <LemonButton
                                            key={i}
                                            fullWidth
                                            onClick={item.onClick}
                                            disabledReason={item.disabledReason}
                                            data-attr={item['data-attr']}
                                        >
                                            {item.title}
                                        </LemonButton>
                                    ))}
                                </>
                            ) : null}
                        </>
                    ),
                }}
            >
                {buttonCopy ?? 'Export'}
            </LemonButtonWithDropdown>
        )
    })