@types/react-helmet

  • Version 6.1.3
  • Published
  • 7.41 kB
  • 1 dependency
  • MIT license

Install

npm i @types/react-helmet
yarn add @types/react-helmet
pnpm add @types/react-helmet

Overview

TypeScript definitions for react-helmet

Index

Variables

variable canUseDOM

const canUseDOM: boolean;

    variable Helmet

    const Helmet: typeof Helmet;

      variable HelmetExport

      const HelmetExport: typeof Helmet;

        Interfaces

        interface HelmetData

        interface HelmetData {}

          property base

          base: HelmetDatum;

            property bodyAttributes

            bodyAttributes: HelmetHTMLBodyDatum;

              property htmlAttributes

              htmlAttributes: HelmetHTMLElementDatum;
                link: HelmetDatum;

                  property meta

                  meta: HelmetDatum;

                    property noscript

                    noscript: HelmetDatum;

                      property script

                      script: HelmetDatum;

                        property style

                        style: HelmetDatum;

                          property title

                          title: HelmetDatum;

                            property titleAttributes

                            titleAttributes: HelmetDatum;

                              interface HelmetDatum

                              interface HelmetDatum {}

                                method toComponent

                                toComponent: () => any;

                                  method toString

                                  toString: () => string;

                                    interface HelmetHTMLBodyDatum

                                    interface HelmetHTMLBodyDatum {}

                                      method toComponent

                                      toComponent: () => any;

                                        method toString

                                        toString: () => string;

                                          interface HelmetHTMLElementDatum

                                          interface HelmetHTMLElementDatum {}

                                            method toComponent

                                            toComponent: () => any;

                                              method toString

                                              toString: () => string;

                                                interface HelmetProps

                                                interface HelmetProps {}

                                                  property async

                                                  async?: boolean | undefined;

                                                    property base

                                                    base?: any;

                                                      property bodyAttributes

                                                      bodyAttributes?: BodyProps | undefined;

                                                        property defaultTitle

                                                        defaultTitle?: string | undefined;

                                                          property defer

                                                          defer?: boolean | undefined;

                                                            property encodeSpecialCharacters

                                                            encodeSpecialCharacters?: boolean | undefined;

                                                              property htmlAttributes

                                                              htmlAttributes?: HtmlProps | undefined;
                                                                link?: LinkProps[] | undefined;

                                                                  property meta

                                                                  meta?: MetaProps[] | undefined;

                                                                    property noscript

                                                                    noscript?: any[] | undefined;

                                                                      property onChangeClientState

                                                                      onChangeClientState?:
                                                                      | ((newState: any, addedTags: HelmetTags, removedTags: HelmetTags) => void)
                                                                      | undefined;

                                                                        property script

                                                                        script?: any[] | undefined;

                                                                          property style

                                                                          style?: any[] | undefined;

                                                                            property title

                                                                            title?: string | undefined;

                                                                              property titleAttributes

                                                                              titleAttributes?: object | undefined;

                                                                                property titleTemplate

                                                                                titleTemplate?: string | undefined;

                                                                                  interface HelmetTags

                                                                                  interface HelmetTags {}

                                                                                    property baseTag

                                                                                    baseTag: any[];

                                                                                      property linkTags

                                                                                      linkTags: HTMLLinkElement[];

                                                                                        property metaTags

                                                                                        metaTags: HTMLMetaElement[];

                                                                                          property noscriptTags

                                                                                          noscriptTags: any[];

                                                                                            property scriptTags

                                                                                            scriptTags: HTMLScriptElement[];

                                                                                              property styleTags

                                                                                              styleTags: HTMLStyleElement[];

                                                                                                Type Aliases

                                                                                                type HelmetPropsToState

                                                                                                type HelmetPropsToState = HelmetTags &
                                                                                                Pick<
                                                                                                HelmetProps,
                                                                                                | 'bodyAttributes'
                                                                                                | 'defer'
                                                                                                | 'htmlAttributes'
                                                                                                | 'onChangeClientState'
                                                                                                | 'title'
                                                                                                | 'titleAttributes'
                                                                                                > & {
                                                                                                encode: Required<HelmetProps['encodeSpecialCharacters']>;
                                                                                                };
                                                                                                • Used by Helmet.peek()

                                                                                                Package Files (1)

                                                                                                Dependencies (1)

                                                                                                Dev Dependencies (0)

                                                                                                No dev dependencies.

                                                                                                Peer Dependencies (0)

                                                                                                No peer dependencies.

                                                                                                Badge

                                                                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-helmet.

                                                                                                • Markdown
                                                                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/react-helmet)
                                                                                                • HTML
                                                                                                  <a href="https://www.jsdocs.io/package/@types/react-helmet"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>