import React from "react"; /** * @param {string} [locale="en_US"] - The locale to use for the badge. Defaults to `"en_US"`. * @param {("medium"|"large")} [size="medium"] - The size of the badge. By default, the badge is set to `"medium"`. * @param {("light"|"dark")} [theme="light"] - The theme of the badge. By default, the badge is set to `"light"`. * @param {("VERTICAL"|"HORIZONTAL")} [props.type="VERTICAL"] - The orientation of the badge. By default, the badge is set to `"VERTICAL"`. * @param {string} [vanity="☯liu"] - The vanity name or URL to display on the badge. * @param {("v1"|"v2")} [version="v1"] - The version of the badge to use. Uses `"v1"` by default. * @param {string} [className] - Additional CSS classes to apply to the badge container. * @param {React.CSSProperties} [style] - Inline styles to apply to the badge container. * @param {string} [id] - The ID to assign to the badge container. * @param {string} [script_src] - The URL of an external script to include for the badge. * @param {string} [name] - The name to display on the badge. * @param {string} [entity] - The entity type of the badge, defaults to `"PROFILE"`. * @param {boolean} [hideViewProfileButton] - Defaults as `false`, if set `true`, the view profile button will be hidden that is displayed as part of the badge's content as a button that when clicked opens the LinkedIn profile page in a new tab. * @param {useLinkedInApiUrlPure} [useLinkedInApiUrlPure] - Defaults as `false`, if set `true`, profile badges are rendered fully through LinkedIn's badge rendering method and only through LinkedIn's API endpoints. If set to `true`, note that there may be issues surfaced inherent in LinkedIn's implementation of profile badges. * @param {boolean} [generateUidWithoutApi] - Defaults as `false`, if `true`, uid creation won't include utilizing an API call to form a more unique uid. * @param {ReactNode} [children] - The children to render within the badge container, only supported when useLinkedInApiUrlPure is set to `false`, hence when rendering the badge within the component itself and without the LinkedIn's badge rendering API's callback injection with iframe method. * @param {cleanUp} [noClean] - Defaults as `false` and is only used when `useLinkedInApiUrlPure` is set to `true`, if set to `true`, the callback function used by the server-side rendering will be cleaned up and deleted after rendering the profile badge. * @param {boolean} [noCache] - Default is `false`, set to `true` to disable the caching of profile badge data in the browser's local storage. Caching is only done when rendering through the * component's self-rendering method and not through the LinkedIn's badge rendering API's callback injection with iframe method. * @example * ```tsx * * ``` * **/ export type LinkedInBadgeProps = { /** * The locale to use for the badge. Defaults to `"en_US"`. */ locale: string; /** * The size of the badge. By default, the badge is set to `"medium"`. */ size: "medium" | "large"; /** * The theme of the badge. By default, the badge is set to `"light"`. */ theme: "light" | "dark"; /** * The orientation of the badge. By default, the badge is set to `"VERTICAL"`. */ type: "VERTICAL" | "HORIZONTAL"; /** * The entity type of the badge, defaults to `"PROFILE"`. At this time only "PROFILE" is supported. */ entity: "PROFILE" | "COMPANY" | "GROUP"; /** * The vanity name or URL to display on the badge. (vanity name is the part of the LinkedIn profile URL that comes after the `/in/` or `/company/` or `/group/` part) */ vanity: string; /** * The version of the badge to use. Uses `"v1"` by default. At this time only "v1" is supported. v2 has never been tested or known to work. */ version: "v1" | "v2"; /** * Optional, an addtional class name to add to the badge container that is the most outer container of the badge. */ className: string; /** * Optional, inline styles to apply to the badge container. */ style: React.CSSProperties; /** * Optional, additional components that are rendered after the badge container. */ children: React.ReactNode; /** * Optional, defaults to `false`, if true, saves and uses localStorage for badge data for faster rendering and caches the data for 24 hours. */ noCache: boolean; /** * Optional, an element ID to assign to the badge container. */ id: string; /** * Only implemented for the self-rendering method (e.g. when pure is set to `false`), will useQuery instead of a default fetch call to get the profile data. */ useQueryToFetch: boolean; /** * Optional, the script that is used to render the badge. This is only used when `useLinkedInApiUrlPure` is set to `true`, which uses linkedin's rendering method. */ script_src: string; /** * Optional, the name to display on the badge. */ name: string; /** * Provides console logs if set to `true`. */ debug: boolean; /** * Defaults as `false`, if set `true`, the view profile button will be hidden that is displayed as part of the badge's content as a button that when clicked opens the LinkedIn profile page in a new tab. */ hideViewProfileButton: boolean; /** * Defaults as `false`, if set `true`, uid creation won't include utilizing an API call to form a more unique uid. */ generateUidWithoutApi: boolean; /** * Defaults as `false`, if set `true`, profile badges are rendered fully through LinkedIn's badge rendering method and only through LinkedIn's API endpoints. If set to `true`, note that there may be issues surfaced inherent in LinkedIn's implementation of profile badges. */ useLinkedInApiUrlPure: boolean; /** * Defaults as `false` and is only used when `useLinkedInApiUrlPure` is set to `true`, if set to `true`, the callback function used by the server-side rendering will be cleaned up and deleted after rendering the profile badge. */ cleanUp: boolean; }; declare const _default: React.NamedExoticComponent>; export default _default; //# sourceMappingURL=index.d.ts.map