@primer/react-brand 0.3.0-rc.7c3326c → 0.3.1-rc.9ad887b

package/CHANGELOG.md

@@ -1,10 +1,24 @@
 # @primer/react-brand
 
+## 0.3.1
+
+### Patch Changes
+
+- [#59](https://github.com/primer/react-brand/pull/59) [`fdc731b`](https://github.com/primer/react-brand/commit/fdc731bda050aaef7041aafe6aaa7857c49ea03b) Thanks [@rezrah](https://github.com/rezrah)! - Added `fillMedia` prop to River.Visual
+
+  Previously, all image and video children were automatically styled to fit the parent elements dimensions.
+
+  This isn't ideal in all situations, so the ability to toggle-off this behaviour is now available through an `fillMedia` prop.
+
 ## 0.3.0
 
 ### Minor Changes
 
-- [#45](https://github.com/primer/react-brand/pull/45) [`2fb6924`](https://github.com/primer/react-brand/commit/2fb6924a834ddcbad34cfb97ecfc1659d54f4ed5) Thanks [@rezrah](https://github.com/rezrah)! - > **Warning**
+- [`c8609a8`](https://github.com/primer/react-brand/commit/c8609a8d35ea80192d85e97794390207f4624e63) Thanks [@rezrah](https://github.com/rezrah)! - added an FAQ component, which displays a list of questions and answers relating to a particular subject.
+
+  [See usage examples](https://primer.style/react-brand/components/FAQ)
+
+* [#45](https://github.com/primer/react-brand/pull/45) [`2fb6924`](https://github.com/primer/react-brand/commit/2fb6924a834ddcbad34cfb97ecfc1659d54f4ed5) Thanks [@rezrah](https://github.com/rezrah)! - > **Warning**
 
   > This is a breaking change, but as the library is a pre-v1 release we are publishing this update as a `minor` change.
   > Please read the following instructions carefully before updating:

package/lib/Accordion/Accordion.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+/**
+ * Design tokens
+ */
+import '../../lib/design-tokens/css/tokens/functional/components/accordion/colors-with-modes.css';
+export declare type AccordionRootProps = {
+    open?: boolean;
+    className?: string;
+    children: React.ReactElement<AccordionHeadingProps | AccordionContentProps>[];
+} & React.HTMLAttributes<HTMLDetailsElement>;
+export declare function AccordionRoot({ children, className, open, ...rest }: AccordionRootProps): JSX.Element;
+declare type AccordionHeadingProps = {
+    className?: string;
+    children: string;
+};
+export declare function AccordionHeading({ children, className }: AccordionHeadingProps): JSX.Element;
+declare type AccordionContentProps = {
+    className?: string;
+    children: React.ReactElement | React.ReactElement[];
+};
+export declare function AccordionContent({ children, className }: AccordionContentProps): JSX.Element;
+/**
+ * Branded Accordion component
+ */
+export declare const Accordion: typeof AccordionRoot & {
+    Content: typeof AccordionContent;
+    Heading: typeof AccordionHeading;
+};
+export {};

package/lib/Accordion/Accordion.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/Accordion/index.d.ts

@@ -0,0 +1 @@
+export * from './Accordion';

package/lib/Button/Button.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/ExpandableArrow/ExpandableArrow.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/FAQ/FAQ.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import { AccordionHeading, AccordionContent, AccordionRoot, AccordionRootProps } from '..';
+/**
+ * Design tokens
+ */
+import '../../lib/design-tokens/css/tokens/functional/components/faq/base.css';
+import '../../lib/design-tokens/css/tokens/functional/components/faq/colors-with-modes.css';
+declare type FAQRootProps = {
+    className?: string;
+    children: React.ReactElement<FAQHeadingProps | FAQSubheadingProps | AccordionRootProps>[];
+};
+declare function FAQRoot({ children, className }: FAQRootProps): JSX.Element;
+declare type FAQHeadingProps = {
+    className?: string;
+    size?: 'medium' | 'large';
+    align?: 'start' | 'center';
+    children: string;
+};
+declare function FAQHeading({ children, className, size, align }: FAQHeadingProps): JSX.Element;
+declare type FAQSubheadingProps = {
+    align?: 'start' | 'center';
+    className?: string;
+    children: string;
+};
+declare function FAQSubheading({ children, className }: FAQSubheadingProps): JSX.Element;
+/**
+ * FAQ component:
+ * {@link https://primer.style/react-brand/components/FAQ/ See usage examples}.
+ */
+export declare const FAQ: typeof FAQRoot & {
+    Subheading: typeof FAQSubheading;
+    Heading: typeof FAQHeading;
+    Item: typeof AccordionRoot;
+    Question: typeof AccordionHeading;
+    Answer: typeof AccordionContent;
+};
+export {};

package/lib/FAQ/FAQ.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/FAQ/index.d.ts

@@ -0,0 +1 @@
+export * from './FAQ';

package/lib/Heading/Heading.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/Hero/Hero.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/InlineLink/InlineLink.d.ts

@@ -0,0 +1,24 @@
+import React, { PropsWithChildren } from 'react';
+import { TextSizes } from '../';
+/**
+ * Design tokens
+ */
+import '../../lib/design-tokens/css/tokens/functional/components/inline-link/colors-with-modes.css';
+export declare type InlineLinkProps = {
+    /**
+     * Forward a custom HTML class attribute
+     */
+    className?: string;
+    /**
+     * Specify the links destination
+     */
+    href: string;
+    /**
+     * Specify the text size
+     */
+    size?: typeof TextSizes[number];
+} & React.AnchorHTMLAttributes<HTMLAnchorElement>;
+/**
+ * A HTML anchor link component that renders inline with adjacent text.
+ */
+export declare function InlineLink({ className, size, children, href, ...rest }: PropsWithChildren<InlineLinkProps>): JSX.Element;

package/lib/InlineLink/InlineLink.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/InlineLink/index.d.ts

@@ -0,0 +1 @@
+export * from './InlineLink';

package/lib/Link/Link.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/MonaSans/MonaSans.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/River/River.d.ts

@@ -51,6 +51,11 @@ declare type RiverContentProps = {
 export declare const getHeadingWarning: (size: (typeof HeadingTags)[number]) => string;
 declare function Content({ children, leadingComponent: LeadingComponent, trailingComponent: TrailingComponent }: RiverContentProps): JSX.Element;
 declare type RiverVisualProps = {
+    /**
+     * Applies automatic size constraints to child images and video.
+     * This can be disabled by setting this prop to `false`.
+     */
+    fillMedia?: boolean;
     className?: string;
     /**
      * `img` and `video` elements will apply a shadow by default.
@@ -58,7 +63,7 @@ declare type RiverVisualProps = {
      */
     hasShadow?: boolean;
 };
-declare function Visual({ children, className, hasShadow }: React.PropsWithChildren<RiverVisualProps>): JSX.Element;
+declare function Visual({ fillMedia, children, className, hasShadow }: React.PropsWithChildren<RiverVisualProps>): JSX.Element;
 /**
  * Alternating text and image pairs.
  */

package/lib/River/River.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/Text/Text.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/ThemeProvider/ThemeProvider.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};