Skip to content
HydrafetchPublic

About

React components for company logos, powered by a Hydrafetch publishable key

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

@hydrafetch/react

npm CI bundle size

React components for company logos, powered by a Hydrafetch publishable key.

738 bytes gzipped. React is a peer dependency. Logos bill against logo pulls, not credits.

Installation

npm install @hydrafetch/react

Quick start

import { HydrafetchProvider, Logo } from '@hydrafetch/react';

export default function App() {
  return (
    <HydrafetchProvider publishableKey={process.env.NEXT_PUBLIC_HYDRAFETCH_PK!}>
      <Logo domain="stripe.com" size={32} />
    </HydrafetchProvider>
  );
}

Create a publishable key in your dashboard and restrict it to your domains.

Components

<HydrafetchProvider>

Holds the key so it is not repeated at every call site, and optionally the theme so every logo below it matches your page.

<HydrafetchProvider publishableKey="hf_pk_..." theme={resolvedTheme}>
  {children}
</HydrafetchProvider>

Throws on any key that does not begin with hf_pk_, which prevents a secret key reaching a browser bundle.

Prop Values Notes
publishableKey required must begin with hf_pk_
theme light, dark, auto the default for every Logo and useLogoUrl beneath it
baseUrl a URL defaults to https://img.hydrafetch.com

<Logo>

<Logo domain="stripe.com" size={32} theme="auto" type="icon" fallback="monogram" className="rounded" />
Prop Values Notes
domain required https://www.stripe.com/pricing is normalised to stripe.com
size pixels, up to 512 adds a 2x srcSet
theme light, dark, auto overrides the provider; auto follows the system preference
type icon, wordmark defaults to the mark
fallback monogram, 404, transparent what an unknown domain returns

Any other image attribute passes through. alt defaults to "{domain} logo" and can be overridden.

Getting the theme right

A logo is usually one colour, and the wrong one is invisible rather than merely wrong. A white mark on a white card reads to your users as a missing logo.

theme="auto" reads prefers-color-scheme in the browser and re-renders when the user changes it, which a server-rendered URL cannot do. That is the right choice only if your app's theme follows the operating system.

If your app has its own light and dark toggle, pass the theme you resolved instead. Set it once on the provider and every logo follows:

const { resolvedTheme } = useTheme();

<HydrafetchProvider publishableKey={KEY} theme={resolvedTheme === 'dark' ? 'dark' : 'light'}>
  <Logo domain="github.com" size={32} />
</HydrafetchProvider>

Leaving auto on an app with a toggle breaks exactly when a visitor sets your toggle against their OS, which is when a broken logo is most visible.

useLogoUrl(domain, options?)

Returns the URL string, for background images or a framework's own image component.

const src = useLogoUrl('stripe.com', { size: 64, theme: 'auto' });

Server components

<Logo> is a client component because it reads prefers-color-scheme. In a React Server Component, either place it behind a 'use client' boundary, or render a plain image with an explicit theme:

<img src={`https://img.hydrafetch.com/logo/${domain}?token=${KEY}&size=32&theme=dark`} />

Billing

Logos are metered against logoPullsPerCycle on your plan and never draw on your credit balance, so rendering logos on every page view does not consume the budget used for scraping.

Related packages

Links

License

MIT

About

React components for company logos, powered by a Hydrafetch publishable key

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages