Skip to content

Commit

Permalink
docs(feedback): 📝 update docs fo feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
navin-moorthy committed Jul 26, 2022
1 parent a74f677 commit a8e84df
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 104 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
},
"dependencies": {
"@adaptui/react": "1.0.0-alpha.9",
"@adaptui/react-tailwind": "0.1.0-alpha.4",
"@adaptui/react-tailwind": "0.1.0-alpha.5",
"@chakra-ui/hooks": "2.0.4",
"@reach/skip-nav": "0.17.0",
"ariakit": "2.0.0-next.36",
Expand Down
7 changes: 3 additions & 4 deletions pages/docs/components/feedback/circular-progress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ import {
ComponentLinks,
InteractiveCodeblock,
PropsTable,
Codeblock,
} from "@/components/index";

# CircularProgress

The CircularProgress component is used to indicate the progress for determinate
and indeterminate processes.
and indeterminate processes. It uses AdaptUI Core's
[Progress](https://github.com/adaptui/react/blob/main/docs/progress.md)
component internally.

<ComponentLinks
github="circular-progress"
Expand All @@ -24,8 +25,6 @@ import {
CircularProgressBar,
CircularProgressBarWrapper,
CircularProgressHint,
useCircularProgressProps,
useCircularProgressState,
CircularProgressTrack,
CircularProgressTrackWrapper,
} from "@adaptui/react-tailwind";
Expand Down
7 changes: 3 additions & 4 deletions pages/docs/components/feedback/meter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ import {
ComponentLinks,
InteractiveCodeblock,
PropsTable,
Codeblock,
} from "@/components/index";

# Meter

Meter is used to display finite value that are within a known range eg., CPU
usage.
usage. It uses AdaptUI Core's
[Meter](https://github.com/adaptui/react/blob/main/docs/meter.md) component
internally.

<ComponentLinks github="meter" theme="meter" story="feedback-meter" />

Expand All @@ -21,8 +22,6 @@ import {
MeterBarWrapper,
MeterHint,
MeterLabel,
useMeterProps,
useMeterState,
MeterTrack,
MeterWrapper,
} from "@adaptui/react-tailwind";
Expand Down
4 changes: 3 additions & 1 deletion pages/docs/components/feedback/progress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import {
# Progress

Progress is used to display the progress status for a task that takes a long
time or consists of several steps.
time or consists of several steps. It uses AdaptUI Core's
[Progress](https://github.com/adaptui/react/blob/main/docs/progress.md)
component internally.

<ComponentLinks github="progress" theme="progress" story="feedback-progress" />

Expand Down
4 changes: 2 additions & 2 deletions pages/docs/components/feedback/show-more.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import {
ComponentLinks,
InteractiveCodeblock,
Codeblock,
PropsTable,
} from "@/components/index";

# ShowMore

ShowMore is used to display the progress status for a task that takes a long
time or consists of several steps.
time or consists of several steps. It uses Arikits's
[Disclosure](https://reakit.io/docs/disclosure/) component internally.

<ComponentLinks github="show-more" story="feedback-showmore" />

Expand Down
4 changes: 2 additions & 2 deletions pages/docs/components/feedback/spinner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ import {
ComponentLinks,
InteractiveCodeblock,
PropsTable,
Codeblock,
} from "@/components/index";

# Spinner

Spinners provide a visual cue that an action is either processing, awaiting a
course of change or a result.
course of change or a result. It uses AdaptUI's
[Box](/docs/components/primitives/box) component internally.

<ComponentLinks github="spinner" theme="spinner" story="feedback-spinner" />

Expand Down
104 changes: 14 additions & 90 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
# yarn lockfile v1


"@adaptui/[email protected].4":
version "0.1.0-alpha.4"
resolved "https://registry.yarnpkg.com/@adaptui/react-tailwind/-/react-tailwind-0.1.0-alpha.4.tgz#e7fdb9a89896fa4deaf11f4adfc71bee18cf5af7"
integrity sha512-7X4GgEoVtll+Vbut6dahFoTZ6J+7XGcctnhgKMo4GMCOl8zhoU9j3HuW47EhvJ4jhjeVP7KcTrfSJ3zZoNHcIw==
"@adaptui/[email protected].5":
version "0.1.0-alpha.5"
resolved "https://registry.yarnpkg.com/@adaptui/react-tailwind/-/react-tailwind-0.1.0-alpha.5.tgz#d70ab84e1e56e88ee495b5fce4ef7bdec671026e"
integrity sha512-V1hHFwE0xecPWEfcExMlNB2/dVsxcgWcXXSzpxPzR3jz67HncApwvD21GpEc7+JuIfvBh9aowRepJL789unlOg==
dependencies:
"@adaptui/react" "^1.0.0-alpha.7"
"@react-aria/live-announcer" "^3.1.0"
ariakit "2.0.0-next.31"
ariakit-utils "0.17.0-next.22"
tailwind-merge "^1.3.0"
"@adaptui/react" "1.0.0-alpha.9"
"@react-aria/live-announcer" "3.1.0"
ariakit "2.0.0-next.36"
ariakit-utils "0.17.0-next.23"
tailwind-merge "1.5.1"

"@adaptui/[email protected]":
version "1.0.0-alpha.9"
Expand All @@ -37,30 +37,6 @@
ariakit-utils "0.17.0-next.23"
raf "^3.4.1"

"@adaptui/react@^1.0.0-alpha.7":
version "1.0.0-alpha.7"
resolved "https://registry.yarnpkg.com/@adaptui/react/-/react-1.0.0-alpha.7.tgz#e5090f26a37d266218975672bd89dfe124d97833"
integrity sha512-cdgdAbLXII+g2CzD80400yt1s0H+g3rWSmJzkUXrSz416duUv+HHxaFT6hejZ1sI1Iv+DY2HkBJm+GlOWN4oVA==
dependencies:
"@chakra-ui/react-utils" "^2.0.1"
"@chakra-ui/utils" "^2.0.2"
"@internationalized/date" "3.0.0"
"@react-aria/button" "^3.5.1"
"@react-aria/calendar" "3.0.0"
"@react-aria/datepicker" "3.0.0"
"@react-aria/i18n" "^3.4.1"
"@react-aria/numberfield" "^3.2.1"
"@react-aria/slider" "^3.1.1"
"@react-aria/spinbutton" "^3.1.1"
"@react-aria/utils" "^3.13.1"
"@react-stately/calendar" "3.0.0"
"@react-stately/datepicker" "3.0.0"
"@react-stately/numberfield" "^3.1.1"
"@react-stately/slider" "^3.1.1"
ariakit "2.0.0-next.30"
ariakit-utils "0.17.0-next.21"
raf "^3.4.1"

"@ampproject/remapping@^2.1.0":
version "2.1.2"
resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.1.2.tgz#4edca94973ded9630d20101cd8559cedb8d8bd34"
Expand Down Expand Up @@ -1646,30 +1622,11 @@
minimatch "^3.1.2"
strip-json-comments "^3.1.1"

"@floating-ui/core@^0.7.3":
version "0.7.3"
resolved "https://registry.yarnpkg.com/@floating-ui/core/-/core-0.7.3.tgz#d274116678ffae87f6b60e90f88cc4083eefab86"
integrity sha512-buc8BXHmG9l82+OQXOFU3Kr2XQx9ys01U/Q9HMIrZ300iLc8HLMgh7dcCqgYzAzf4BkoQvDcXf5Y+CuEZ5JBYg==

"@floating-ui/core@^1.0.0":
version "1.0.0"
resolved "https://registry.yarnpkg.com/@floating-ui/core/-/core-1.0.0.tgz#ec1d31f54c72dd0460276e2149e59bd13c0f01f6"
integrity sha512-sm3nW0hHAxTv3gRDdCH8rNVQxijF+qPFo5gAeXCErRjKC7Qc28lIQ3R9Vd7Gw+KgwfA7RhRydDFuGeI0peGq7A==

"@floating-ui/[email protected]":
version "0.5.3"
resolved "https://registry.yarnpkg.com/@floating-ui/dom/-/dom-0.5.3.tgz#ade192cf9a911fc3e95fb614fe281658b654043c"
integrity sha512-vpjWB1uC7rajvgA58uzlJZgtWqrdDQLw+XVA3w63ZTmsWwRmVd0Gl5Dy9VMAViI9cP7hBWaJt23Jy3AVgVYnoQ==
dependencies:
"@floating-ui/core" "^0.7.3"

"@floating-ui/[email protected]":
version "0.5.4"
resolved "https://registry.yarnpkg.com/@floating-ui/dom/-/dom-0.5.4.tgz#4eae73f78bcd4bd553ae2ade30e6f1f9c73fe3f1"
integrity sha512-419BMceRLq0RrmTSDxn8hf9R3VCJv2K9PUfugh5JyEFmdjzDo+e8U5EdR8nzKq8Yj1htzLm3b6eQEEam3/rrtg==
dependencies:
"@floating-ui/core" "^0.7.3"

"@floating-ui/dom@^1.0.0":
version "1.0.0"
resolved "https://registry.yarnpkg.com/@floating-ui/dom/-/dom-1.0.0.tgz#66923a56755b6cb7a5958ecf25fe293912672d65"
Expand Down Expand Up @@ -2496,7 +2453,7 @@
"@react-types/label" "^3.6.1"
"@react-types/shared" "^3.13.1"

"@react-aria/live-announcer@^3.1.0":
"@react-aria/live-announcer@3.1.0", "@react-aria/live-announcer@^3.1.0":
version "3.1.0"
resolved "https://registry.yarnpkg.com/@react-aria/live-announcer/-/live-announcer-3.1.0.tgz#06cfce35f6a9bcff266ab0ceab97f2fe6e487975"
integrity sha512-YEaGJh1ELho3G9zvUZGOsKsSNEqHsm0fb3Ngvj9z0tjZCXa0867h8YWKuiyTA9BG7WhH8eeJq07WN4nDvYU7fg==
Expand Down Expand Up @@ -3545,37 +3502,11 @@ aria-query@^5.0.0:
resolved "https://registry.yarnpkg.com/aria-query/-/aria-query-5.0.0.tgz#210c21aaf469613ee8c9a62c7f86525e058db52c"
integrity sha512-V+SM7AbUwJ+EBnB8+DXs0hPZHO0W6pqBcc0dW90OwtVG02PswOu/teuARoLQjdDOH+t9pJgGnW5/Qmouf3gPJg==

[email protected]:
version "0.17.0-next.21"
resolved "https://registry.yarnpkg.com/ariakit-utils/-/ariakit-utils-0.17.0-next.21.tgz#bff902e8bca565c8f0a9946a63d5e24676370025"
integrity sha512-2zVBplN6O92WKDRy3RKafdl+BK0V7HtRpRX179YiWVG4ZTeeTNfj/m23d91SImue514U7PmxEp/DQb+LucQu+g==

[email protected]:
version "0.17.0-next.22"
resolved "https://registry.yarnpkg.com/ariakit-utils/-/ariakit-utils-0.17.0-next.22.tgz#3d12871646979e1f9674ba0de1ca45018ee243ba"
integrity sha512-S2BUE4IvsX2g7y7EqwarVfxWS5sgtOqobfuTdkJO9HGASWv5nw0L1MMGtyt+HSkvMMdmPgKNQ8wMqixuWSk74g==

[email protected]:
version "0.17.0-next.23"
resolved "https://registry.yarnpkg.com/ariakit-utils/-/ariakit-utils-0.17.0-next.23.tgz#b9c5f638e5cc7a3ddc2e3256f23d42718e3af47b"
integrity sha512-r6a8rvjTBNbdNVWhGm4XL8hTlpIlP0G+yJf3No48kK6QpR1JN9QinLI/wMwWwJnxDYfwnBhkbcROCqF7iT/4ig==

[email protected]:
version "2.0.0-next.30"
resolved "https://registry.yarnpkg.com/ariakit/-/ariakit-2.0.0-next.30.tgz#436eb631f82d04313d8b7b77f106de48b40cf64e"
integrity sha512-12CW6eY6i+3FPjB5ItIxRtet5pfLBML7bbCrrrDKEj1hIrUELvJu7HqFCvhNFTzODgVU8s1xr4rEUigaz/58rA==
dependencies:
"@floating-ui/dom" "0.5.3"
ariakit-utils "0.17.0-next.21"

[email protected]:
version "2.0.0-next.31"
resolved "https://registry.yarnpkg.com/ariakit/-/ariakit-2.0.0-next.31.tgz#75bb914dd77c9e5bd4cc7e9a6502534e22621cd3"
integrity sha512-ChBErZ3/qLVcrtqFXME5/fS6EcM/qN8A/6shgu5TDTqERfH5hw3iTzOW4Z2r+srIVltj8Ab+kwCXgG3UgMlE/Q==
dependencies:
"@floating-ui/dom" "0.5.4"
ariakit-utils "0.17.0-next.22"

[email protected]:
version "2.0.0-next.36"
resolved "https://registry.yarnpkg.com/ariakit/-/ariakit-2.0.0-next.36.tgz#74b93cc839cfd9e8350c4cc961b06b8f70f16e14"
Expand Down Expand Up @@ -6245,11 +6176,6 @@ has@^1.0.3:
dependencies:
function-bind "^1.1.1"

hashlru@^2.3.0:
version "2.3.0"
resolved "https://registry.yarnpkg.com/hashlru/-/hashlru-2.3.0.tgz#5dc15928b3f6961a2056416bb3a4910216fdfb51"
integrity sha512-0cMsjjIC8I+D3M44pOQdsy0OHXGLVz6Z0beRuufhKa0KfaD2wGwAev6jILzXsd3/vpnNQJmWyZtIILqM1N+n5A==

hast-util-to-estree@^2.0.0:
version "2.0.2"
resolved "https://registry.yarnpkg.com/hast-util-to-estree/-/hast-util-to-estree-2.0.2.tgz#79c5bf588915610b3f0d47ca83a74dc0269c7dc2"
Expand Down Expand Up @@ -10620,12 +10546,10 @@ symbol-tree@^3.2.4:
resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.4.tgz#430637d248ba77e078883951fb9aa0eed7c63fa2"
integrity sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==

tailwind-merge@^1.3.0:
version "1.3.0"
resolved "https://registry.yarnpkg.com/tailwind-merge/-/tailwind-merge-1.3.0.tgz#fa29557a2e1c6947904143e45884e554f491937d"
integrity sha512-M+DC6DO5eypc3/iOt/oTuqUH68Ip+XCu/Afybg9/ATxUX6KMPk4UGU4z4EMx08BMOBL+iOL93+hx3Jxpb9qNGw==
dependencies:
hashlru "^2.3.0"
[email protected]:
version "1.5.1"
resolved "https://registry.yarnpkg.com/tailwind-merge/-/tailwind-merge-1.5.1.tgz#fb7d6b724aef702b11fd01fddf1be1d8aeab3d7a"
integrity sha512-lqmJS6+3vsNQY77TMMRBVFbWyMcIAAD/09Vs+IXCt3cza58/O7X5DBbOu+7p6LPhw0efK45LL8kAJ7IORccMag==

[email protected]:
version "3.1.6"
Expand Down

0 comments on commit a8e84df

Please sign in to comment.