Select

The UI that’s displayed when loading the root page of the OpenAuth server. You can configure which providers should be displayed in the select UI.

import { Select } from "@openauthjs/openauth/ui/select"

export default issuer({
  select: Select({
    providers: {
      github: {
        hide: true
      },
      google: {
        display: "Google"
      }
    }
  })
  // ...
})

---

Methods

Select

Select(props?)

Parameters

• props? SelectProps

Returns (providers: Record<string, string>, _req: Request<>) => Promise<Response<>>

SelectProps

• providers? Record<string, Object>

  • display? string

  • hide? boolean

SelectProps.providers?

Type Record<string, Object>

An object with all the providers and their config; where the key is the provider name.

{
  github: {
    hide: true
  },
  google: {
    display: "Google"
  }
}

SelectProps.providers[].display?

Type string

The display name of the provider.

SelectProps.providers[].hide?

Type boolean

Default false

Whether to hide the provider from the select UI.