Create shimmer.md

mu-dawood · Mar 3, 2023 · beb23b2 · beb23b2
1 parent d9830e8
commit beb23b2
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/docs/en/shimmer.md 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")
+   )
+ ),
+```