@intility/bifrost-react-select 4.0.0-beta.8 → 4.0.0

package/CHANGELOG.md

@@ -1,134 +1,17 @@
 # @intility/bifrost-react-select
 
-## 4.0.0-beta.8
-
-### Patch Changes
-
-- Updated dependencies [3849abc3]
-  - @intility/bifrost-react@4.0.0-beta.7
-
-## 4.0.0-beta.7
-
-### Patch Changes
-
-- Updated dependencies [82ab21b5]
-- Updated dependencies [81af701b]
-  - @intility/bifrost-react@4.0.0-beta.6
-
-## 4.0.0-beta.6
+## 4.0.0 (first release)
 
 ### Minor Changes
 
+- 62b02461: Include JSDoc comments in typescript definition output
 - 6b355639: New styling for inputs, now always outlined. Removed `variant` prop from `<Input>`.
 
 ### Patch Changes
 
-- Updated dependencies [6b355639]
-- Updated dependencies [6b355639]
-  - @intility/bifrost-react@4.0.0-beta.5
-
-## 4.0.0-beta.5
-
-### Patch Changes
-
-- e410a910: New base color values for light mode #711
-- Updated dependencies [e410a910]
-  - @intility/bifrost-react@4.0.0-beta.4
-
-## 4.0.0-beta.4
-
-### Patch Changes
-
+- 217c8741: Named export for Select and DatePicker
 - a903f282: fix: export typescript types used in react components
-- Updated dependencies [a903f282]
-- Updated dependencies [19500ce7]
-- Updated dependencies [8263586d]
-  - @intility/bifrost-react@4.0.0-beta.3
-
-## 4.0.0-beta.3
-
-### Patch Changes
-
-- Updated dependencies [b60c063d]
-  - @intility/bifrost-react@4.0.0-beta.2
-
-## 4.0.0-beta.2
-
-### Major Changes
-
-- 608d2083: update module output
-
-### Patch Changes
-
+- e410a910: New base color values for light mode #711
+- ea861dbc: Update lint config, add displayName for components
 - 165904af: use deep imports from @intility/bifrost-react
-- Updated dependencies [165904af]
-- Updated dependencies [608d2083]
-  - @intility/bifrost-react@4.0.0-beta.1
-
-## 4.0.0-beta.1
-
-### Patch Changes
-
-- 217c8741: Named export for Select and DatePicker
-
-## 4.0.0-beta.0
-
-### Major Changes
-
-- 5c7ba5a4: split react-select and react-datepicker
-
-### Patch Changes
-
-- Updated dependencies [3785f8d6]
-- Updated dependencies [5c7ba5a4]
-- Updated dependencies [5cb3ebac]
-- Updated dependencies [d8bd3f72]
-- Updated dependencies [df1f169d]
-- Updated dependencies [727894c3]
-  - @intility/bifrost-react@4.0.0-beta.0
-
-## 4.0.0-alpha.8
-
-### Patch Changes
-
-- Updated dependencies
-  - @intility/bifrost-react@4.0.0-alpha.8
-
-## 4.0.0-alpha.7
-
-### Patch Changes
-
-- Updated dependencies
-  - @intility/bifrost-react@4.0.0-alpha.7
-
-## 4.0.0-alpha.6
-
-### Patch Changes
-
-- Updated dependencies
-  - @intility/bifrost-react@4.0.0-alpha.6
-
-## 4.0.0-alpha.5
-
-### Patch Changes
-
-- Updated dependencies
-  - @intility/bifrost-react@4.0.0-alpha.5
-
-## 4.0.0-alpha.4
-
-### Patch Changes
-
-- Updated dependencies
-  - @intility/bifrost-react@4.0.0-alpha.4
-
-## 4.0.0-alpha.3
-
-### Major Changes
-
-- 5c7ba5a4: split react-select and react-datepicker
-
-### Patch Changes
-
-- Updated dependencies [5c7ba5a4]
-  - @intility/bifrost-react@4.0.0-alpha.3
+- fdc6caee: fix: select dropdown background should no longer bleed outside border radius when opened

package/dist/Select.d.ts

@@ -29,15 +29,25 @@ export declare const selectComponents: Partial<typeof components>;
 declare const selectStates: readonly ["default", "alert"];
 export type SelectState = (typeof selectStates)[number];
 export type SelectProps = {
+    /** Required label text */
     label: ReactNode;
+    /** Hide label text, will add label prop as aria-label for screen readers */
     hideLabel?: boolean;
+    /** Description text to show more information */
     description?: ReactNode;
+    /** Available states: `default` and `alert` */
     state?: SelectState;
+    /** Feedback text below the Select component */
     feedback?: ReactNode;
+    /** Required prop indicating mandatory field */
     required?: boolean;
+    /** Bool to mark Select component required, but hides the required label */
     requiredNoLabel?: boolean;
+    /** Marks Select component as optional */
     optional?: boolean;
+    /** Inline CSS styles */
     style?: CSSProperties;
+    /** Displays a loading spinner */
     loading?: boolean;
 };
 export type SelectType = {
@@ -47,6 +57,9 @@ export type SelectType = {
     }, IsMulti extends boolean = false, Group extends GroupBase<OptionType> = GroupBase<OptionType>>(props: ReactSelectProps<OptionType, IsMulti, Group> & RefAttributes<SelectInstance<OptionType, IsMulti, Group>> & SelectProps): React.ReactElement | null;
     displayName?: string;
 };
+/**
+ *  Select component - dropdown list
+ */
 export declare const Select: SelectType;
 export type AsyncType = {
     <OptionType = {

package/dist/Select.js

@@ -74,7 +74,7 @@ export const selectStyles = {
         }),
     menu: (provided)=>({
             ...provided,
-            backgroundColor: "var(--bfc-base-3)",
+            backgroundColor: "transparent",
             boxShadow: "none",
             borderRadius: "none",
             marginTop: 0,
@@ -185,7 +185,7 @@ const selectStates = [
  *  Select HOC
  */ const SelectHOC = (Selector)=>{
     // @ts-ignore
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, react/display-name
     const GeneratedSelect = /*#__PURE__*/ forwardRef(({ label, hideLabel = false, isDisabled = false, state, feedback, required = false, description, requiredNoLabel = false, optional = false, inputId, className, style, loading = false, components, ...props }, ref)=>{
         const selectId = useUniqueId(inputId);
         return /*#__PURE__*/ _jsxs("div", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intility/bifrost-react-select",
-  "version": "4.0.0-beta.8",
+  "version": "4.0.0",
   "description": "React select component for Intility's design system, Bifrost.",
   "type": "module",
   "main": "dist/Select.js",
@@ -11,7 +11,8 @@
     "start": "run-p watch:*",
     "watch:module": "npm run build:module -- --watch",
     "watch:types": "npm run build:types -- --watch --preserveWatchOutput",
-    "clean": "rimraf dist"
+    "clean": "rimraf dist",
+    "lint": "eslint ./src/**/*.{ts,tsx}"
   },
   "exports": {
     "./package.json": "./package.json",
@@ -40,7 +41,7 @@
     "@fortawesome/fontawesome-svg-core": "^6.4.2",
     "@fortawesome/free-solid-svg-icons": "^6.4.2",
     "@fortawesome/react-fontawesome": "^0.2.0",
-    "@intility/bifrost-react": "4.0.0-beta.7",
+    "@intility/bifrost-react": "4.0.0",
     "classnames": "^2.2.6",
     "react-select": "^5.7.7"
   }

package/src/Select.tsx

@@ -111,7 +111,7 @@ export const selectStyles = {
   }),
   menu: (provided) => ({
     ...provided,
-    backgroundColor: "var(--bfc-base-3)",
+    backgroundColor: "transparent",
     boxShadow: "none",
     borderRadius: "none",
     marginTop: 0,
@@ -238,7 +238,7 @@ export type SelectState = (typeof selectStates)[number];
  */
 const SelectHOC = <Type, Selector>(Selector: Selector) => {
   // @ts-ignore
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, react/display-name
   const GeneratedSelect: Type = forwardRef<any, any>(
     (
       {