All files / modules/10-common/hooks useDocumentTitle.ts

100% Statements 17/17
100% Branches 6/6
100% Functions 7/7
100% Lines 15/15

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43              83x 83x 83x               83x 620x 620x   620x   620x 293x 879x       620x 293x   293x   242x       620x        
/*
 * Copyright 2021 Harness Inc. All rights reserved.
 * Use of this source code is governed by the PolyForm Shield 1.0.0 license
 * that can be found in the licenses directory at the root of this repository, also available at
 * https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
 */
 
import { useStrings } from 'framework/strings'
import { useAppStore } from 'framework/AppStore/AppStoreContext'
import { useDeepCompareEffect } from '@common/hooks/useDeepCompareEffect'
 
export type Title = string | string[]
 
export interface UseDocumentTitleReturn {
  updateTitle: (newTitle: Title) => void
}
 
export function useDocumentTitle(title: Title): UseDocumentTitleReturn {
  const { getString } = useStrings()
  const { selectedProject } = useAppStore()
 
  const getStringFromTitle = (str: Title): string => (Array.isArray(str) ? str.filter(s => s).join(' | ') : str)
 
  const updateTitle = (newTitle: Title): void => {
    document.title = [getStringFromTitle(newTitle), selectedProject?.name, getString('harness')]
      .filter(s => s)
      .join(' | ')
  }
 
  useDeepCompareEffect(() => {
    updateTitle(title)
 
    return () => {
      // reset title on unmount
      document.title = getString('harness')
    }
  }, [title, selectedProject])
 
  return {
    updateTitle
  }
}