@raspberrypifoundation/design-system-react 2.6.0 → 2.6.2

package/dist/types/src/components/Tag/Tag.types.d.ts

@@ -0,0 +1,13 @@
+export type TagProps = {
+    /** The text content of the tag */
+    text: string;
+    /** The variant of the tag. Is ignored if you add a custom modifier. */
+    variant?: 'default' | 'information' | 'success' | 'warning' | 'error';
+    /** The secondary (inverted) look of all variants. */
+    secondary?: boolean;
+    /** A list of available icon names can be found here. Write names as snake case (so "Check Circle" becomes check_circle). */
+    icon?: string;
+    /** The position of the icon */
+    iconPosition?: 'left' | 'right';
+};
+//# sourceMappingURL=Tag.types.d.ts.map

package/dist/types/src/components/Tag/Tag.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tag.types.d.ts","sourceRoot":"","sources":["../../../../../src/components/Tag/Tag.types.ts"],"names":[],"mappings":"AAAE,MAAM,MAAM,QAAQ,GAAG;IACrB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,uEAAuE;IACvE,OAAO,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;IACrE,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,4HAA4H;IAC5H,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,+BAA+B;IAC/B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAChC,CAAA"}

package/dist/types/src/components/Tag/index.d.ts

@@ -1,19 +1,5 @@
-export function Tag({ text, variant, secondary, icon, iconPosition }: {
-    text: any;
-    variant: any;
-    secondary: any;
-    icon: any;
-    iconPosition: any;
-}): import("react/jsx-runtime").JSX.Element;
-export namespace Tag {
-    namespace propTypes {
-        let text: PropTypes.Validator<string>;
-        let variant: PropTypes.Requireable<string>;
-        let secondary: PropTypes.Requireable<boolean>;
-        let icon: PropTypes.Requireable<string>;
-        let iconPosition: PropTypes.Requireable<string>;
-    }
-}
+import "./Tag.scss";
+import type { TagProps } from "./Tag.types";
+export declare const Tag: ({ text, variant, secondary, icon, iconPosition, }: TagProps) => import("react/jsx-runtime").JSX.Element;
 export default Tag;
-import PropTypes from "prop-types";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/components/Tag/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/Tag/index.jsx"],"names":[],"mappings":"AAKO;;;;;;4CA4BN;;;;;;;;;;;sBAjCqB,YAAY"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/Tag/index.tsx"],"names":[],"mappings":"AAEA,OAAO,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,eAAO,MAAM,GAAG,GAAI,mDAMjB,QAAQ,4CAwBV,CAAC;AAEF,eAAe,GAAG,CAAC"}

package/dist/types/src/stories/Alert.stories.d.ts

@@ -1,92 +1,41 @@
-export default options;
-export namespace Default {
-    let args: {};
-}
-export namespace Error {
-    export namespace args_1 {
-        let type: string;
-        let children: import("react/jsx-runtime").JSX.Element;
-    }
-    export { args_1 as args };
-}
-export namespace Warning {
-    export namespace args_2 {
-        let type_1: string;
-        export { type_1 as type };
-    }
-    export { args_2 as args };
-}
-export namespace Success {
-    export namespace args_3 {
-        let type_2: string;
-        export { type_2 as type };
-    }
-    export { args_3 as args };
-}
-export namespace WithActions {
-    export namespace args_4 {
-        let type_3: string;
-        export { type_3 as type };
-        export let actions: ({
-            label: string;
-            onClick: () => void;
-            href?: undefined;
-        } | {
-            href: string;
-            label: string;
-            onClick?: undefined;
-        })[];
-    }
-    export { args_4 as args };
-    export let decorators: ((Story: any) => import("react/jsx-runtime").JSX.Element)[];
-}
-export namespace WithClose {
-    export namespace args_5 {
-        let type_4: string;
-        export { type_4 as type };
-        export function onClose(): void;
-    }
-    export { args_5 as args };
-}
-export namespace WithCustomTitle {
-    export namespace args_6 {
-        export let titleChildren: import("react/jsx-runtime").JSX.Element;
-        export let text: string;
-        let type_5: string;
-        export { type_5 as type };
-    }
-    export { args_6 as args };
-}
-declare namespace options {
-    export let title: string;
-    export { Alert as component };
-    export let tags: string[];
-    let type_6: string;
-    export { type_6 as type };
-    export namespace argTypes {
-        export namespace type_7 {
-            namespace control {
-                let type_8: string;
-                export { type_8 as type };
-            }
-            let options: string[];
-        }
-        export { type_7 as type };
-        export namespace onClose_1 {
-            let description: string;
-        }
-        export { onClose_1 as onClose };
-    }
-    export namespace args_7 {
-        let title_1: string;
-        export { title_1 as title };
-        let type_9: string;
-        export { type_9 as type };
-        let text_1: string;
-        export { text_1 as text };
-        let onClose_2: null;
-        export { onClose_2 as onClose };
-    }
-    export { args_7 as args };
-}
+import type { Meta, StoryObj } from "@storybook/react";
+import { Alert } from "../components/Alert";
+/**
+ * Alerts are used to call out important information.
+ *
+ * Simplest use: `<Alert title="" text="" type=""/>`
+ *
+ * For each story, click "Show code" to see the code featuring all available props defined.
+ *
+ * ### Alert types
+ * There are three main types:
+ * * error
+ * * warning
+ * * information
+ * * success
+ *
+ * Use the `type` prop: `<Alert type="error" .../>`
+ *
+ * ### Title/text or children
+ * You may provide plain text to title/text or custom children, `titleChildren` prop for title and `children` prop for text. Do not provide both plain text and children to title/text.
+ *
+ * ### Actions
+ * An array of actions can be provided, these will show clickable links.
+ *
+ * e.g. `<Alert ... actions={[ {href: '', label: ''} ]}/>`
+ *
+ */
+declare const meta: Meta<typeof Alert>;
+export default meta;
+type Story = StoryObj<typeof Alert>;
+/**
+ * Primary buttons are used to denote the main action that the user should take next.
+ */
+export declare const Default: Story;
+export declare const Error: Story;
+export declare const Warning: Story;
+export declare const Success: Story;
+export declare const WithActions: Story;
+export declare const WithClose: Story;
+export declare const WithCustomTitle: Story;
 //# sourceMappingURL=Alert.stories.d.ts.map

package/dist/types/src/stories/Alert.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Alert.stories.d.ts","sourceRoot":"","sources":["../../../../src/stories/Alert.stories.jsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqHa,gCAER"}
+{"version":3,"file":"Alert.stories.d.ts","sourceRoot":"","sources":["../../../../src/stories/Alert.stories.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,KAAK,CAqB5B,CAAC;AAEF,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,KAIrB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,KAYnB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,KAIrB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,KAIrB,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,KAuBzB,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,KAOvB,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,KAW7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raspberrypifoundation/design-system-react",
-  "version": "2.6.0",
+  "version": "2.6.2",
   "type": "module",
   "main": "./dist/design-system-react.umd.cjs",
   "module": "./dist/design-system-react.js",