@silas-test/ob-atoms-price 0.1.0

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@silas-test/ob-atoms-price",
+  "version": "0.1.0",
+  "dependencies": {
+    "@silas-test/ui-utils": "0.6.5"
+  },
+  "main": "./index.cjs.js",
+  "type": "commonjs",
+  "types": "./index.d.ts"
+}

package/src/index.d.ts

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

package/src/lib/price.d.ts

@@ -0,0 +1,3 @@
+import { IPriceProps } from './price.interface';
+import './price.css';
+export declare const Price: import("react").ForwardRefExoticComponent<IPriceProps & import("react").RefAttributes<HTMLDivElement>>;

package/src/lib/price.interface.d.ts

@@ -0,0 +1,52 @@
+import { DefaultProps } from '@silas-test/ui-utils';
+/** @typedef {string} PriceVariants */
+export type CurrencyPositions = 'left' | 'right';
+/** @typedef {string} PriceVariants */
+export type PriceVariants = 'base' | 'accent' | 'danger';
+/** @typedef {string} PriceSizes */
+export type PriceSizes = 'small' | 'medium';
+/**
+ * @typedef {Object} PriceProps
+ * @property {string | undefined} id - component identification
+ * @property {string | undefined} dataTestId - react-testing-library identification
+ * @property {string} value - value that should be displayed as the text. This value should be already formatted
+ * @property {string} prevValue - previous value that will be used to start the animation effect. This value should be already formatted
+ * @property {string | undefined} currency - character of the currency that should be displayed on the price
+ * @property {CurrencyPositions | undefined} currencyPosition - position of the currency character, either at the left or right of the price
+ * @property {PriceVariants | undefined} variant - styling variant of the component
+ * @property {PriceSizes | undefined} size - size of the text
+ */
+export interface IPriceProps extends DefaultProps {
+    /** Component identification */
+    id?: string;
+    /** React-testing-library identification */
+    dataTestId?: string;
+    /** Value that should be displayed as the text.
+     *
+     * NOTE: This value should be provided already on the format you want to display
+     */
+    value: string;
+    /** Previous value that will be used to start the animation effect.
+     *
+     * NOTE: If the prevValue prop is provided, the `Price` component will animate from the `prevValue` to the `value` prop
+     */
+    prevValue?: string;
+    /** Character of the currency that should be displayed on the price */
+    currency?: string;
+    /** Position of the currency character, either at the `left` or `right` of the price */
+    currencyPosition?: CurrencyPositions;
+    /**
+     * Styling variant of the component.
+     *
+     * Default value is `base`
+     *
+     */
+    variant?: PriceVariants;
+    /**
+     * Size of the text:
+     *
+     * Default value is `medium`
+     *
+     */
+    size?: PriceSizes;
+}

package/src/lib/price.stories.d.ts

@@ -0,0 +1,11 @@
+import type { Meta } from '@storybook/react';
+import { Price } from './price';
+declare const Story: Meta<typeof Price>;
+export default Story;
+export declare const Animated: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;
+export declare const BaseMedium: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;
+export declare const BaseSmall: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;
+export declare const AccentMedium: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;
+export declare const AccentSmall: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;
+export declare const DangerMedium: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;
+export declare const DangerSmall: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./price.interface").IPriceProps & import("react").RefAttributes<HTMLDivElement>>;