@atlaskit/radio 5.5.1 → 5.5.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/radio
 
+## 5.5.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 5.5.1
 
 ### Patch Changes

package/dist/cjs/radio.js

@@ -18,7 +18,7 @@ var _styles = _interopRequireDefault(require("./styles"));
 var _excluded = ["ariaLabel", "isDisabled", "isRequired", "isInvalid", "isChecked", "label", "mode", "name", "onChange", "value", "testId", "analyticsContext"];
 /** @jsx jsx */
 var packageName = "@atlaskit/radio";
-var packageVersion = "5.5.1";
+var packageVersion = "5.5.2";
 var fontFamily = (0, _constants.fontFamily)();
 var noop = _noop.default;
 var labelPaddingStyles = (0, _react2.css)({

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/radio",
-	"version": "5.5.1",
+	"version": "5.5.2",
 	"sideEffects": false
 }

package/dist/es2019/radio.js

@@ -9,7 +9,7 @@ import GlobalTheme from '@atlaskit/theme/components';
 import { fontFamily as getFontFamily } from '@atlaskit/theme/constants';
 import getRadioCustomProperties from './styles';
 const packageName = "@atlaskit/radio";
-const packageVersion = "5.5.1";
+const packageVersion = "5.5.2";
 const fontFamily = getFontFamily();
 const noop = __noop;
 const labelPaddingStyles = css({

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/radio",
-	"version": "5.5.1",
+	"version": "5.5.2",
 	"sideEffects": false
 }

package/dist/esm/radio.js

@@ -11,7 +11,7 @@ import GlobalTheme from '@atlaskit/theme/components';
 import { fontFamily as getFontFamily } from '@atlaskit/theme/constants';
 import getRadioCustomProperties from './styles';
 var packageName = "@atlaskit/radio";
-var packageVersion = "5.5.1";
+var packageVersion = "5.5.2";
 var fontFamily = getFontFamily();
 var noop = __noop;
 var labelPaddingStyles = css({

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/radio",
-	"version": "5.5.1",
+	"version": "5.5.2",
 	"sideEffects": false
 }

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,2 @@
+export { default as RadioGroup } from './radio-group';
+export { default as Radio } from './radio';

package/dist/types-ts4.5/radio-group.d.ts

@@ -0,0 +1,50 @@
+import React, { SyntheticEvent } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { OptionsPropType, RadioValue } from './types';
+export interface RadioGroupProps {
+    /**
+     * Once set, controls the selected value on the `RadioGroup`
+     */
+    value?: RadioValue | null;
+    /**
+     * Sets the initial selected value on the `RadioGroup`
+     */
+    defaultValue?: RadioValue | null;
+    /**
+     * Sets the disabled state of all `Radio` elements in the group. Overrides the `isDisabled` setting of all child `Radio` items.
+     */
+    isDisabled?: boolean;
+    /**
+     * Sets the required state of all `Radio` elements in the group
+     */
+    isRequired?: boolean;
+    /**
+     * Sets the invalid state of all `Radio` elements in the group
+     */
+    isInvalid?: boolean;
+    /**
+     * An array of objects, each object is mapped onto a `Radio` element within the group. Name must be unique to the group.
+     */
+    options: OptionsPropType;
+    /**
+     * Function that gets fired after each invalid event
+     */
+    onInvalid?: (event: SyntheticEvent<any>) => void;
+    /**
+     * Function that gets after each change event
+     */
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
+    /**
+     * Sets the `name` prop on each of the `Radio` elements in the group
+     */
+    name?: string;
+    /**
+     * Additional information to be included in the `context` of analytics events that come from radio
+     */
+    analyticsContext?: Record<string, any>;
+    /**
+     * The id of the element that links to this radiogroup.
+     */
+    'aria-labelledby'?: string;
+}
+export default function RadioGroup(props: RadioGroupProps): JSX.Element;

package/dist/types-ts4.5/radio.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="react" />
+/**
+ * __Radio__
+ *
+ * A radio input allows users to select only one option from a number of choices. Radio is generally displayed in a radio group.
+ *
+ * - [Examples](https://atlassian.design/components/radio/examples)
+ * - [Code](https://atlassian.design/components/radio/code)
+ * - [Usage](https://atlassian.design/components/radio/usage)
+ */
+declare const Radio: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Pick<Omit<Omit<import("react").InputHTMLAttributes<HTMLInputElement>, "aria-label" | "disabled" | "required" | "checked" | "value">, keyof {
+    ariaLabel?: string | undefined;
+    isDisabled?: boolean | undefined;
+    isRequired?: boolean | undefined;
+    isInvalid?: boolean | undefined;
+    isChecked?: boolean | undefined;
+    label?: import("react").ReactNode;
+    onChange?: ((e: import("react").ChangeEvent<HTMLInputElement>, analyticsEvent: import("@atlaskit/analytics-next").UIAnalyticsEvent) => void) | undefined;
+    value?: string | undefined;
+    testId?: string | undefined;
+    analyticsContext?: Record<string, any> | undefined;
+}> & {
+    ariaLabel?: string | undefined;
+    isDisabled?: boolean | undefined;
+    isRequired?: boolean | undefined;
+    isInvalid?: boolean | undefined;
+    isChecked?: boolean | undefined;
+    label?: import("react").ReactNode;
+    onChange?: ((e: import("react").ChangeEvent<HTMLInputElement>, analyticsEvent: import("@atlaskit/analytics-next").UIAnalyticsEvent) => void) | undefined;
+    value?: string | undefined;
+    testId?: string | undefined;
+    analyticsContext?: Record<string, any> | undefined;
+} & import("@atlaskit/analytics-next").WithAnalyticsEventsProps, "accept" | "alt" | "autoComplete" | "autoFocus" | "capture" | "crossOrigin" | "form" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "height" | "list" | "max" | "maxLength" | "min" | "minLength" | "multiple" | "name" | "pattern" | "placeholder" | "readOnly" | "size" | "src" | "step" | "type" | "width" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "slot" | "spellCheck" | "style" | "tabIndex" | "title" | "inputMode" | "is" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | keyof {
+    ariaLabel?: string | undefined;
+    isDisabled?: boolean | undefined;
+    isRequired?: boolean | undefined;
+    isInvalid?: boolean | undefined;
+    isChecked?: boolean | undefined;
+    label?: import("react").ReactNode;
+    onChange?: ((e: import("react").ChangeEvent<HTMLInputElement>, analyticsEvent: import("@atlaskit/analytics-next").UIAnalyticsEvent) => void) | undefined;
+    value?: string | undefined;
+    testId?: string | undefined;
+    analyticsContext?: Record<string, any> | undefined;
+} | "createAnalyticsEvent"> & import("react").RefAttributes<HTMLInputElement>>>;
+export default Radio;

package/dist/types-ts4.5/styles.d.ts

@@ -0,0 +1,18 @@
+import { ThemeModes } from '@atlaskit/theme/types';
+export default function getRadioCustomProperties(mode: ThemeModes): {
+    '--local-background': "var(--ds-background-input)";
+    '--local-background-active': "var(--ds-background-input-pressed)";
+    '--local-background-checked': "var(--ds-background-brand-bold)";
+    '--local-background-checked-active': "var(--ds-background-brand-bold-pressed)";
+    '--local-background-checked-hover': "var(--ds-background-brand-bold-hovered)";
+    '--local-background-disabled': "var(--ds-background-disabled)";
+    '--local-background-hover': "var(--ds-background-input-hovered)";
+    '--local-border': "var(--ds-border-input)";
+    '--local-border-disabled': "var(--ds-border-disabled)";
+    '--local-border-hover': "var(--ds-border-input)";
+    '--local-border-focus': "var(--ds-border-focused)";
+    '--local-dot-active': "var(--ds-icon-inverse)";
+    '--local-dot-checked': "var(--ds-icon-inverse)";
+    '--local-dot-disabled': "var(--ds-icon-disabled)";
+    '--local-invalid': "var(--ds-icon-danger)";
+};

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,118 @@
+import { ReactNode, SyntheticEvent } from 'react';
+import { UIAnalyticsEvent, WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+export type OptionPropType = {
+    isDisabled?: boolean;
+    label?: ReactNode;
+    name?: string;
+    value?: RadioValue;
+    testId?: string;
+};
+export type OptionsPropType = Array<OptionPropType>;
+export type RadioValue = string;
+type OwnProps = {
+    /**
+     * the aria-label attribute associated with the radio element
+     */
+    ariaLabel?: string;
+    /**
+     * Makes a `Radio` field unselectable when true. Overridden by `isDisabled` prop of `RadioGroup`.
+     */
+    isDisabled?: boolean;
+    /**
+     * Marks this as a required field
+     */
+    isRequired?: boolean;
+    /**
+     * Field is invalid
+     */
+    isInvalid?: boolean;
+    /**
+     * Set the field as checked
+     */
+    isChecked?: boolean;
+    /**
+     * The label value for the input rendered to the dom
+     */
+    label?: ReactNode;
+    /**
+     * onChange event handler, passed into the props of each `Radio` Component instantiated within `RadioGroup`
+     */
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
+    /**
+     * Field value
+     */
+    value?: RadioValue;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
+     * we have 2 different testid generated based on the one you pass to the Radio component:
+     * - `{testId}--radio-input` to check if it got changed to checked/unchecked.
+     * - `{testId}--radio-label` to click the input
+     */
+    testId?: string;
+    /**
+     * Additional information to be included in the `context` of analytics events that come from radio
+     */
+    analyticsContext?: Record<string, any>;
+};
+type Combine<First, Second> = Omit<First, keyof Second> & Second;
+export type RadioProps = Combine<Omit<React.InputHTMLAttributes<HTMLInputElement>, 'aria-label' | 'disabled' | 'required' | 'checked' | 'value'>, OwnProps> & WithAnalyticsEventsProps;
+export interface ExtractReactTypeProps extends WithAnalyticsEventsProps {
+    /**
+     * the aria-label attribute associated with the radio element
+     */
+    ariaLabel?: string;
+    /**
+     * Field disabled
+     */
+    isDisabled?: boolean;
+    /**
+     * Marks this as a required field
+     */
+    isRequired?: boolean;
+    /**
+     * Field is invalid
+     */
+    isInvalid?: boolean;
+    /**
+     * Set the field as checked
+     */
+    isChecked?: boolean;
+    /**
+     * The label value for the input rendered to the dom
+     */
+    label?: ReactNode;
+    /**
+     * Field name, must be unique to the radio group
+     */
+    name?: string;
+    /**
+     * `onChange` event handler, passed into the props of each `Radio` Component instantiated within RadioGroup
+     */
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
+    onBlur?: React.FocusEventHandler<HTMLInputElement>;
+    onFocus?: React.FocusEventHandler<HTMLInputElement>;
+    onMouseDown?: React.MouseEventHandler;
+    onMouseUp?: React.MouseEventHandler;
+    onMouseEnter?: React.MouseEventHandler;
+    onMouseLeave?: React.MouseEventHandler;
+    /**
+     * `onInvalid` event handler, passed into the props of each `Radio` component instantiated within `RadioGroup`
+     */
+    onInvalid?: (e: SyntheticEvent<any>) => void;
+    /**
+     * Field value
+     */
+    value?: RadioValue;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
+     * we have two different `testId`s generated based on the one you pass to the Radio component:
+     * - `{testId}--radio-input` to check if it got changed to checked/unchecked.
+     * - `{testId}--radio-label` to click the input
+     */
+    testId?: string;
+    /**
+     * Additional information to be included in the `context` of analytics events that come from radio
+     */
+    analyticsContext?: Record<string, any>;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/radio",
-  "version": "5.5.1",
+  "version": "5.5.2",
   "description": "A radio input allows users to select only one option from a number of choices. Radio is generally displayed in a radio group.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"