From beb23b2513e41ce855e8c4868c7e46009a153654 Mon Sep 17 00:00:00 2001 From: Mohamed Dawood <31937782+mo-ah-dawood@users.noreply.github.com> Date: Fri, 3 Mar 2023 23:48:20 +0200 Subject: [PATCH] Create shimmer.md --- docs/en/shimmer.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/en/shimmer.md diff --git a/docs/en/shimmer.md b/docs/en/shimmer.md new file mode 100644 index 0000000..50e22b5 --- /dev/null +++ b/docs/en/shimmer.md @@ -0,0 +1,26 @@ +### Fisrt you need your widgets with `ShimmerScope` +### Every widget must be wrapped with `Shimmer` + +```dart + +ShimmerScope( + child: List(children:[ + Shimmer(child: Card(child:Text("Item 1"))), + Shimmer(child: Card(child:Text("Item 2"))), + Shimmer(child: Card(child:Text("Item 3"))), + Shimmer(child: Card(child:Text("Item 4"))), + ]) +) +``` + +### enable or disable effect + +```dart + +Shimmer( + enabled: true | false, + child: Card( + child: Text("Item 1") + ) + ), +```