@nypl/design-system-react-components 3.4.0-rc-hero-1 → 3.4.0-rc-hero-3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -29,14 +29,12 @@ export interface HeroProps {
|
|
|
29
29
|
heroType?: HeroTypes;
|
|
30
30
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
31
31
|
id?: string;
|
|
32
|
-
/** Object used to create and render the `Image` component.
|
|
33
|
-
* `alt`, `
|
|
34
|
-
* `imageProps.alt` is left blank, a warning will be logged to the console and
|
|
32
|
+
/** Object used to create and render the `Image` component. You can pass `component`
|
|
33
|
+
* (with its own internal props, which will override) or `src`, `alt`, `id`, `fallBackSrc`, and `onError`.
|
|
34
|
+
* If `imageProps.alt` is left blank, a warning will be logged to the console and
|
|
35
35
|
* will cause accessibility issues. For `imageProps.src`, it will only work for
|
|
36
|
-
* the "secondary", "fiftyFifty" and "campaign" `Hero` types
|
|
37
|
-
|
|
38
|
-
* `Hero` type. Note: not all `Hero` variations utilize this prop. */
|
|
39
|
-
imageProps?: ComponentImageProps;
|
|
36
|
+
* the "secondary", "fiftyFifty" and "campaign" `Hero` types. */
|
|
37
|
+
imageProps?: Pick<ComponentImageProps, "src" | "alt" | "id" | "fallbackSrc" | "onError" | "component">;
|
|
40
38
|
/** Optional boolean used to toggle the default text color from light to dark.
|
|
41
39
|
* Set isDarkText to `true` if the backgroundColor is set to a light color. */
|
|
42
40
|
isDarkText?: boolean;
|