@autoguru/overdrive 4.17.0 → 4.17.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/components/DatePicker/DatePicker.d.ts +4 -4
  2. package/dist/components/DatePicker/DatePicker.d.ts.map +1 -1
  3. package/package.json +5 -4
  4. package/readme.md +19 -20
package/dist/components/DatePicker/DatePicker.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { IconType } from '@autoguru/icons';
2
- import { ComponentProps, FunctionComponent } from 'react';
3
- import { Icon } from '../Icon';
4
- export interface Props extends Partial<Pick<HTMLInputElement, 'min' | 'max' | 'value'>>, Pick<ComponentProps<typeof Icon>, 'size'> {
5
- size: 'small' | 'medium' | 'large';
2
+ import { FunctionComponent } from 'react';
3
+ type SizeScale = 'small' | 'medium' | 'large';
4
+ export interface Props extends Partial<Pick<HTMLInputElement, 'min' | 'max' | 'value'>> {
5
+ size?: SizeScale;
6
6
  className?: string;
7
7
  disabled?: boolean;
8
8
  icon?: IconType;
package/dist/components/DatePicker/DatePicker.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"DatePicker.d.ts","sourceRoot":"","sources":["../../../lib/components/DatePicker/DatePicker.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAgB,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAGzD,OAAO,EAAe,cAAc,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAGvE,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAM/B,MAAM,WAAW,KAChB,SAAQ,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC,CAAC,EAC/D,IAAI,CAAC,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,MAAM,CAAC;IAC1C,IAAI,EAAE,OAAO,GAAC,QAAQ,GAAC,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAE;CACvB;AAOD,eAAO,MAAM,UAAU,EAAE,iBAAiB,CAAC,KAAK,CAsE/C,CAAC;AAEF,eAAe,UAAU,CAAC"}
1
+ {"version":3,"file":"DatePicker.d.ts","sourceRoot":"","sources":["../../../lib/components/DatePicker/DatePicker.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAgB,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAGzD,OAAO,EAA+B,iBAAiB,EAAE,MAAM,OAAO,CAAC;AASvE,KAAK,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,KAChB,SAAQ,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC,CAAC;IAChE,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAE;CACvB;AAOD,eAAO,MAAM,UAAU,EAAE,iBAAiB,CAAC,KAAK,CAsE/C,CAAC;AAEF,eAAe,UAAU,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@autoguru/overdrive",
3
- "version": "4.17.0",
3
+ "version": "4.17.2",
4
4
  "description": "Overdrive is a product component library, and design system for AutoGuru.",
5
5
  "types": "dist/index.d.ts",
6
6
  "main": "dist/index.js",
@@ -10,7 +10,8 @@
10
10
  "react",
11
11
  "storybook",
12
12
  "styleguide",
13
- "ui"
13
+ "ui",
14
+ "autoguru"
14
15
  ],
15
16
  "homepage": "https://overdrive.autoguru.io",
16
17
  "repository": "autoguru-au/overdrive",
@@ -50,8 +51,8 @@
50
51
  "deepmerge": "^4.2.2",
51
52
  "eslint-plugin-jest": "26.9.0",
52
53
  "intersection-observer": "^0.12.2",
53
- "react": "^18.1.0",
54
- "react-dom": "^18.1.0",
54
+ "react": "^18.2.0",
55
+ "react-dom": "^18.2.0",
55
56
  "react-focus-lock": "2.9.4",
56
57
  "react-intersection-observer": "^9.4.3",
57
58
  "react-keyed-flatten-children": "1.3.0",
package/readme.md CHANGED
@@ -10,6 +10,10 @@
10
10
  </div>
11
11
 
12
12
  ---
13
+ # Overdrive
14
+
15
+ Overdrive is a product component library and design system for AutoGuru, built with React, TypeScript, Vanilla Extract, and Storybook.
16
+
13
17
  [Storybook playground](http://overdrive.autoguru.io/).
14
18
 
15
19
  Overdrive is a product component library, and design system for AutoGuru. Built
@@ -20,35 +24,30 @@ with [React](https://github.com/facebook/react),
20
24
 
21
25
  ## Usage
22
26
 
27
+ To use Overdrive in your project, install it via yarn:
23
28
  ```sh
24
29
  yarn add @autoguru/overdrive \
25
30
  react react-dom
26
31
  ```
27
32
 
28
- 1. Import reset
29
-
30
- ```js
31
- import '@autoguru/overdrive/reset';
32
- ```
33
+ Then, import the reset and configure the OverdriveProvider with the theme you want to use:
33
34
 
34
- 2. Import and configure the `OverdriveProvider` complete with the theme you're
35
- wanting to use.
35
+ ```jsx
36
+ import '@autoguru/overdrive/reset';
37
+ // It is important that the reset import happens before any of this.
38
+ import { baseTheme } from '@autoguru/overdrive/lib/themes';
39
+ import { OverdriveProvider, Button } from '@autoguru/overdrive';
36
40
 
37
- ```jsx
38
- // It is important that the reset import happens before any of this.
39
- import { baseTheme } from '@autoguru/overdrive/lib/themes';
40
- import { OverdriveProvider, Button } '@autoguru/overdrive';
41
-
42
- <OverdriveProvider theme={baseTheme}>
43
- <Button variant="primary">
44
- Hello World
45
- </Button>
46
- </OverdriveProvider>
47
- ```
41
+ <OverdriveProvider theme={baseTheme}>
42
+ <Button variant="primary">
43
+ Hello World
44
+ </Button>
45
+ </OverdriveProvider>
46
+ ```
48
47
 
49
- ## Docs
48
+ Documentation
50
49
 
51
- Find more about Overdrive API and usages in our [docs](http://overdrive.autoguru.io/?path=/docs/components-actions--no-wrap).
50
+ For more information on Overdrive's API and usage, check out the [docs](http://overdrive.autoguru.io/?path=/documentation/).
52
51
 
53
52
 
54
53
  ## Thanks