@prefecthq/prefect-design/src/compositions/useOffsetStickyRootMargin.ts

A collection of low-level Vue components.

import { Ref, computed, ref } from 'vue'
import { media } from '@/utilities'

type UseOffsetStickyRootMargin = {
  margin: Ref<string>,
}

export const overrideMargins = ref<string>()

/**
 * The useOffsetStickyRootMargin composition is used to provide a rootMargin
 * value for sticky headers that are intended to align with the top of the page,
 * or just below the mobile nav on smaller screens. Use in conjunction with the
 * usePositionStickyObserver composition from vue-compositions.
 * @returns UseOffsetStickyRootMargin
 */
export function useOffsetStickyRootMargin(): UseOffsetStickyRootMargin {
  const margin = computed(() => {
    if (overrideMargins.value) {
      return overrideMargins.value
    }

    return media.lg ? '-1px 0px 0px 0px' : '-65px 0px 0px 0px'
  })

  return { margin }
}