Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Added Scarf Tag For Tracking #246

Merged
merged 1 commit into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions website/src/components/scarf/Scarf.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import React from 'react'

const ScarfTag = () => {
return (
<img
alt="scarf"
referrerPolicy="no-referrer-when-downgrade"
src="https://static.scarf.sh/a.png?x-pxid=a56ed60e-6f2d-465c-ab2a-409f2086abc5"
/>
)
}

export { ScarfTag }
1 change: 1 addition & 0 deletions website/src/components/scarf/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './Scarf'
167 changes: 167 additions & 0 deletions website/src/theme/Footer/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import React from 'react'
import clsx from 'clsx'
import Link from '@docusaurus/Link'
import { useThemeConfig } from '@docusaurus/theme-common'
import useBaseUrl from '@docusaurus/useBaseUrl'
import isInternalUrl from '@docusaurus/isInternalUrl'
import styles from './styles.module.css'
import ThemedImage from '@theme/ThemedImage'
import IconExternalLink from '@theme/IconExternalLink'
import { ScarfTag } from '../../components/scarf'

function FooterLink({ to, href, label, prependBaseUrlToHref, ...props }) {
const toUrl = useBaseUrl(to)
const normalizedHref = useBaseUrl(href, {
forcePrependBaseUrl: true
})
return (
<Link
className="footer__link-item"
{...(href
? {
href: prependBaseUrlToHref ? normalizedHref : href
}
: {
to: toUrl
})}
{...props}>
{href && !isInternalUrl(href) ? (
<span>
{label}
<IconExternalLink />
</span>
) : (
label
)}
</Link>
)
}

function FooterLogo({ sources, alt, width, height }) {
return <ThemedImage className="footer__logo" alt={alt} sources={sources} width={width} height={height} />
}

function MultiColumnLinks({ links }) {
return (
<>
{links.map((linkItem, i) => (
<div key={i} className="col footer__col">
<div className="footer__title">{linkItem.title}</div>
<ul className="footer__items">
{linkItem.items.map((item, key) =>
item.html ? (
<li
key={key}
className="footer__item" // Developer provided the HTML, so assume it's safe.
// eslint-disable-next-line react/no-danger
dangerouslySetInnerHTML={{
__html: item.html
}}
/>
) : (
<li key={item.href || item.to} className="footer__item">
<FooterLink {...item} />
</li>
)
)}
</ul>
</div>
))}
</>
)
}

function SimpleLinks({ links }) {
return (
<div className="footer__links">
{links.map((item, key) => (
<>
{item.html ? (
<span
key={key}
className="footer__link-item" // Developer provided the HTML, so assume it's safe.
// eslint-disable-next-line react/no-danger
dangerouslySetInnerHTML={{
__html: item.html
}}
/>
) : (
<FooterLink {...item} />
)}
{links.length !== key + 1 && <span className="footer__link-separator">·</span>}
</>
))}
</div>
)
}

function isMultiColumnFooterLinks(links) {
return 'title' in links[0]
}

function Footer() {
const { footer } = useThemeConfig()
const { copyright, links = [], logo = {} } = footer || {}
const sources = {
light: useBaseUrl(logo.src),
dark: useBaseUrl(logo.srcDark || logo.src)
}

if (!footer) {
return null
}

return (
<footer
className={clsx('footer', {
'footer--dark': footer.style === 'dark'
})}>
<div className="container container-fluid">
{links &&
links.length > 0 &&
(isMultiColumnFooterLinks(links) ? (
<div className="row footer__links">
<MultiColumnLinks links={links} />
</div>
) : (
<div className="footer__links text--center">
<SimpleLinks links={links} />
</div>
))}
{(logo || copyright) && (
<div className="footer__bottom text--center">
{logo && (logo.src || logo.srcDark) && (
<div className="margin-bottom--sm">
{logo.href ? (
<Link href={logo.href} className={styles.footerLogoLink}>
<FooterLogo alt={logo.alt} sources={sources} width={logo.width} height={logo.height} />
</Link>
) : (
<FooterLogo alt={logo.alt} sources={sources} />
)}
</div>
)}
{copyright ? (
<div
className="footer__copyright" // Developer provided the HTML, so assume it's safe.
// eslint-disable-next-line react/no-danger
dangerouslySetInnerHTML={{
__html: copyright
}}
/>
) : null}
</div>
)}
</div>
<ScarfTag />
</footer>
)
}

export default React.memo(Footer)
15 changes: 15 additions & 0 deletions website/src/theme/Footer/styles.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

.footerLogoLink {
opacity: 0.5;
transition: opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);
}

.footerLogoLink:hover {
opacity: 1;
}
Loading