diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..179e299 Binary files /dev/null and b/.DS_Store differ diff --git a/.gitbook/assets/#2.png b/.gitbook/assets/#2.png deleted file mode 100644 index e76da35..0000000 Binary files a/.gitbook/assets/#2.png and /dev/null differ diff --git a/.gitbook/assets/Accordion.png b/.gitbook/assets/Accordion.png deleted file mode 100644 index cf9ad36..0000000 Binary files a/.gitbook/assets/Accordion.png and /dev/null differ diff --git a/.gitbook/assets/Animation -scaling.gif b/.gitbook/assets/Animation -scaling.gif deleted file mode 100644 index 629386e..0000000 Binary files a/.gitbook/assets/Animation -scaling.gif and /dev/null differ diff --git a/.gitbook/assets/Animation docs banner.gif b/.gitbook/assets/Animation docs banner.gif deleted file mode 100644 index 8723d9a..0000000 Binary files a/.gitbook/assets/Animation docs banner.gif and /dev/null differ diff --git a/.gitbook/assets/Animation- allignment.gif b/.gitbook/assets/Animation- allignment.gif deleted file mode 100644 index 4d5c407..0000000 Binary files a/.gitbook/assets/Animation- allignment.gif and /dev/null differ diff --git a/.gitbook/assets/Animation- slide.gif b/.gitbook/assets/Animation- slide.gif deleted file mode 100644 index 62a0a70..0000000 Binary files a/.gitbook/assets/Animation- slide.gif and /dev/null differ diff --git a/.gitbook/assets/Animation-Rotation.gif b/.gitbook/assets/Animation-Rotation.gif deleted file mode 100644 index 65bdba5..0000000 Binary files a/.gitbook/assets/Animation-Rotation.gif and /dev/null differ diff --git a/.gitbook/assets/Animation-container.gif b/.gitbook/assets/Animation-container.gif deleted file mode 100644 index 721ca85..0000000 Binary files a/.gitbook/assets/Animation-container.gif and /dev/null differ diff --git a/.gitbook/assets/Animation-size.gif b/.gitbook/assets/Animation-size.gif deleted file mode 100644 index b3b430e..0000000 Binary files a/.gitbook/assets/Animation-size.gif and /dev/null differ diff --git a/.gitbook/assets/Basic checkbox.png b/.gitbook/assets/Basic checkbox.png deleted file mode 100644 index bda3966..0000000 Binary files a/.gitbook/assets/Basic checkbox.png and /dev/null differ diff --git a/.gitbook/assets/Basic radio button.png b/.gitbook/assets/Basic radio button.png deleted file mode 100644 index 02e316c..0000000 Binary files a/.gitbook/assets/Basic radio button.png and /dev/null differ diff --git a/.gitbook/assets/Basic shimmer effect@2x.png b/.gitbook/assets/Basic shimmer effect@2x.png deleted file mode 100644 index a116ed2..0000000 Binary files a/.gitbook/assets/Basic shimmer effect@2x.png and /dev/null differ diff --git a/.gitbook/assets/Bottom sheet Docs banner.gif b/.gitbook/assets/Bottom sheet Docs banner.gif deleted file mode 100644 index 5f0de01..0000000 Binary files a/.gitbook/assets/Bottom sheet Docs banner.gif and /dev/null differ diff --git a/.gitbook/assets/Bottom sheets WIthout overlay@3x.png b/.gitbook/assets/Bottom sheets WIthout overlay@3x.png deleted file mode 100644 index 1f199da..0000000 Binary files a/.gitbook/assets/Bottom sheets WIthout overlay@3x.png and /dev/null differ diff --git a/.gitbook/assets/Checkbox list tile@3x.png b/.gitbook/assets/Checkbox list tile@3x.png deleted file mode 100644 index b0ff05d..0000000 Binary files a/.gitbook/assets/Checkbox list tile@3x.png and /dev/null differ diff --git a/.gitbook/assets/Circular checkbox.png b/.gitbook/assets/Circular checkbox.png deleted file mode 100644 index e27115c..0000000 Binary files a/.gitbook/assets/Circular checkbox.png and /dev/null differ diff --git a/.gitbook/assets/Circular loaders@2x.png b/.gitbook/assets/Circular loaders@2x.png deleted file mode 100644 index 38d52ed..0000000 Binary files a/.gitbook/assets/Circular loaders@2x.png and /dev/null differ diff --git a/.gitbook/assets/Custom checkbox.png b/.gitbook/assets/Custom checkbox.png deleted file mode 100644 index 1f79b95..0000000 Binary files a/.gitbook/assets/Custom checkbox.png and /dev/null differ diff --git a/.gitbook/assets/Dashed border - circle.png b/.gitbook/assets/Dashed border - circle.png deleted file mode 100644 index de75a48..0000000 Binary files a/.gitbook/assets/Dashed border - circle.png and /dev/null differ diff --git a/.gitbook/assets/Dashed border - circle@3x.png b/.gitbook/assets/Dashed border - circle@3x.png deleted file mode 100644 index 5e1208f..0000000 Binary files a/.gitbook/assets/Dashed border - circle@3x.png and /dev/null differ diff --git a/.gitbook/assets/Dashed borders@3x.png b/.gitbook/assets/Dashed borders@3x.png deleted file mode 100644 index f64788b..0000000 Binary files a/.gitbook/assets/Dashed borders@3x.png and /dev/null differ diff --git a/.gitbook/assets/Docs banner -Checkboxes@2x.png b/.gitbook/assets/Docs banner -Checkboxes@2x.png deleted file mode 100644 index 4526940..0000000 Binary files a/.gitbook/assets/Docs banner -Checkboxes@2x.png and /dev/null differ diff --git a/.gitbook/assets/Docs banner-Borders@2x.png b/.gitbook/assets/Docs banner-Borders@2x.png deleted file mode 100644 index b482925..0000000 Binary files a/.gitbook/assets/Docs banner-Borders@2x.png and /dev/null differ diff --git a/.gitbook/assets/Docs banner-Bottomsheets@2x.png b/.gitbook/assets/Docs banner-Bottomsheets@2x.png deleted file mode 100644 index 9f4cdf2..0000000 Binary files a/.gitbook/assets/Docs banner-Bottomsheets@2x.png and /dev/null differ diff --git a/.gitbook/assets/Docs banner-Checkbox list tile@2x.png b/.gitbook/assets/Docs banner-Checkbox list tile@2x.png deleted file mode 100644 index 026deb3..0000000 Binary files a/.gitbook/assets/Docs banner-Checkbox list tile@2x.png and /dev/null differ diff --git a/.gitbook/assets/Docs banner-Radio button @2x.png b/.gitbook/assets/Docs banner-Radio button @2x.png deleted file mode 100644 index 76d0671..0000000 Binary files a/.gitbook/assets/Docs banner-Radio button @2x.png and /dev/null differ diff --git a/.gitbook/assets/Docs banner-Radio list tile@2x.png b/.gitbook/assets/Docs banner-Radio list tile@2x.png deleted file mode 100644 index 64983b1..0000000 Binary files a/.gitbook/assets/Docs banner-Radio list tile@2x.png and /dev/null differ diff --git a/.gitbook/assets/Dotted border@3x.png b/.gitbook/assets/Dotted border@3x.png deleted file mode 100644 index e0e756a..0000000 Binary files a/.gitbook/assets/Dotted border@3x.png and /dev/null differ diff --git a/.gitbook/assets/Dotted borders@3x.png b/.gitbook/assets/Dotted borders@3x.png deleted file mode 100644 index 0347a3f..0000000 Binary files a/.gitbook/assets/Dotted borders@3x.png and /dev/null differ diff --git a/.gitbook/assets/GW-Borders docs banner.png b/.gitbook/assets/GW-Borders docs banner.png deleted file mode 100644 index 303b4bc..0000000 Binary files a/.gitbook/assets/GW-Borders docs banner.png and /dev/null differ diff --git a/.gitbook/assets/Introscreens full width.gif b/.gitbook/assets/Introscreens full width.gif deleted file mode 100644 index fa0ae46..0000000 Binary files a/.gitbook/assets/Introscreens full width.gif and /dev/null differ diff --git a/.gitbook/assets/Introscreens-half.gif b/.gitbook/assets/Introscreens-half.gif deleted file mode 100644 index bf0a94b..0000000 Binary files a/.gitbook/assets/Introscreens-half.gif and /dev/null differ diff --git a/.gitbook/assets/Progress bar with child property@2x.png b/.gitbook/assets/Progress bar with child property@2x.png deleted file mode 100644 index 1a00944..0000000 Binary files a/.gitbook/assets/Progress bar with child property@2x.png and /dev/null differ diff --git a/.gitbook/assets/Radiolist tile@3x.png b/.gitbook/assets/Radiolist tile@3x.png deleted file mode 100644 index 007c26e..0000000 Binary files a/.gitbook/assets/Radiolist tile@3x.png and /dev/null differ diff --git a/.gitbook/assets/Ratings@2x.png b/.gitbook/assets/Ratings@2x.png deleted file mode 100644 index b0546dc..0000000 Binary files a/.gitbook/assets/Ratings@2x.png and /dev/null differ diff --git a/.gitbook/assets/Rotation@3x.png b/.gitbook/assets/Rotation@3x.png deleted file mode 100644 index 2b2c1a7..0000000 Binary files a/.gitbook/assets/Rotation@3x.png and /dev/null differ diff --git a/.gitbook/assets/Shimmer effect on text@2x.png b/.gitbook/assets/Shimmer effect on text@2x.png deleted file mode 100644 index f07716f..0000000 Binary files a/.gitbook/assets/Shimmer effect on text@2x.png and /dev/null differ diff --git a/.gitbook/assets/Solid borders@3x.png b/.gitbook/assets/Solid borders@3x.png deleted file mode 100644 index f0460fd..0000000 Binary files a/.gitbook/assets/Solid borders@3x.png and /dev/null differ diff --git a/.gitbook/assets/Square checkbox.png b/.gitbook/assets/Square checkbox.png deleted file mode 100644 index f8c2245..0000000 Binary files a/.gitbook/assets/Square checkbox.png and /dev/null differ diff --git a/.gitbook/assets/Square radio buttons.png b/.gitbook/assets/Square radio buttons.png deleted file mode 100644 index a61a027..0000000 Binary files a/.gitbook/assets/Square radio buttons.png and /dev/null differ diff --git a/.gitbook/assets/Square-solid-button.png b/.gitbook/assets/Square-solid-button.png deleted file mode 100644 index dd84b18..0000000 Binary files a/.gitbook/assets/Square-solid-button.png and /dev/null differ diff --git a/.gitbook/assets/Standard buttons - solid@2x.png b/.gitbook/assets/Standard buttons - solid@2x.png deleted file mode 100644 index 1493884..0000000 Binary files a/.gitbook/assets/Standard buttons - solid@2x.png and /dev/null differ diff --git a/.gitbook/assets/Sticky headers docs baner_compressed.gif b/.gitbook/assets/Sticky headers docs baner_compressed.gif deleted file mode 100644 index 9df59ae..0000000 Binary files a/.gitbook/assets/Sticky headers docs baner_compressed.gif and /dev/null differ diff --git a/.gitbook/assets/Sticky headers docs banner.gif b/.gitbook/assets/Sticky headers docs banner.gif deleted file mode 100644 index 46ad01a..0000000 Binary files a/.gitbook/assets/Sticky headers docs banner.gif and /dev/null differ diff --git a/.gitbook/assets/Sticky headers-basic.gif b/.gitbook/assets/Sticky headers-basic.gif deleted file mode 100644 index fad6060..0000000 Binary files a/.gitbook/assets/Sticky headers-basic.gif and /dev/null differ diff --git a/.gitbook/assets/Sticky headers-customized.gif b/.gitbook/assets/Sticky headers-customized.gif deleted file mode 100644 index 7a202d3..0000000 Binary files a/.gitbook/assets/Sticky headers-customized.gif and /dev/null differ diff --git a/.gitbook/assets/Transparent social button@2x.png b/.gitbook/assets/Transparent social button@2x.png deleted file mode 100644 index bc1eb0e..0000000 Binary files a/.gitbook/assets/Transparent social button@2x.png and /dev/null differ diff --git a/.gitbook/assets/accordian with text@2x.png b/.gitbook/assets/accordian with text@2x.png deleted file mode 100644 index 53146f5..0000000 Binary files a/.gitbook/assets/accordian with text@2x.png and /dev/null differ diff --git a/.gitbook/assets/accordion with icon@2x.png b/.gitbook/assets/accordion with icon@2x.png deleted file mode 100644 index b7027f2..0000000 Binary files a/.gitbook/assets/accordion with icon@2x.png and /dev/null differ diff --git a/.gitbook/assets/alert with multiple buttons@2x.png b/.gitbook/assets/alert with multiple buttons@2x.png deleted file mode 100644 index 4ceac1c..0000000 Binary files a/.gitbook/assets/alert with multiple buttons@2x.png and /dev/null differ diff --git a/.gitbook/assets/allignment@3x.png b/.gitbook/assets/allignment@3x.png deleted file mode 100644 index 3634203..0000000 Binary files a/.gitbook/assets/allignment@3x.png and /dev/null differ diff --git a/.gitbook/assets/block button@2x.png b/.gitbook/assets/block button@2x.png deleted file mode 100644 index e0e9c39..0000000 Binary files a/.gitbook/assets/block button@2x.png and /dev/null differ diff --git a/.gitbook/assets/block social button@2x (1).png b/.gitbook/assets/block social button@2x (1).png deleted file mode 100644 index b6783a1..0000000 Binary files a/.gitbook/assets/block social button@2x (1).png and /dev/null differ diff --git a/.gitbook/assets/block social button@2x.png b/.gitbook/assets/block social button@2x.png deleted file mode 100644 index 9679f0a..0000000 Binary files a/.gitbook/assets/block social button@2x.png and /dev/null differ diff --git a/.gitbook/assets/cards with avatars@2x.png b/.gitbook/assets/cards with avatars@2x.png deleted file mode 100644 index a43620b..0000000 Binary files a/.gitbook/assets/cards with avatars@2x.png and /dev/null differ diff --git a/.gitbook/assets/cards with image overlays@2x.png b/.gitbook/assets/cards with image overlays@2x.png deleted file mode 100644 index 0643381..0000000 Binary files a/.gitbook/assets/cards with image overlays@2x.png and /dev/null differ diff --git a/.gitbook/assets/circular border - oval-solid@3x.png b/.gitbook/assets/circular border - oval-solid@3x.png deleted file mode 100644 index 409e69d..0000000 Binary files a/.gitbook/assets/circular border - oval-solid@3x.png and /dev/null differ diff --git a/.gitbook/assets/custom_radio_1 (1) (1).png b/.gitbook/assets/custom_radio_1 (1) (1).png deleted file mode 100644 index ee949de..0000000 Binary files a/.gitbook/assets/custom_radio_1 (1) (1).png and /dev/null differ diff --git a/.gitbook/assets/Custom_radio_1.png b/.gitbook/assets/custom_radio_1.png similarity index 100% rename from .gitbook/assets/Custom_radio_1.png rename to .gitbook/assets/custom_radio_1.png diff --git a/.gitbook/assets/custom_radio_2 (1) (1).png b/.gitbook/assets/custom_radio_2 (1) (1).png deleted file mode 100644 index 9185142..0000000 Binary files a/.gitbook/assets/custom_radio_2 (1) (1).png and /dev/null differ diff --git a/.gitbook/assets/dashed border with radius.png b/.gitbook/assets/dashed border with radius.png deleted file mode 100644 index 3c0fc8e..0000000 Binary files a/.gitbook/assets/dashed border with radius.png and /dev/null differ diff --git a/.gitbook/assets/dashed border.png b/.gitbook/assets/dashed border.png deleted file mode 100644 index a1d9254..0000000 Binary files a/.gitbook/assets/dashed border.png and /dev/null differ diff --git a/.gitbook/assets/dashed border@3x.png b/.gitbook/assets/dashed border@3x.png deleted file mode 100644 index 5307255..0000000 Binary files a/.gitbook/assets/dashed border@3x.png and /dev/null differ diff --git a/.gitbook/assets/disabled buttons@2x.png b/.gitbook/assets/disabled buttons@2x.png deleted file mode 100644 index 8407ee9..0000000 Binary files a/.gitbook/assets/disabled buttons@2x.png and /dev/null differ diff --git a/.gitbook/assets/full width button@2x.png b/.gitbook/assets/full width button@2x.png deleted file mode 100644 index 5caa3ba..0000000 Binary files a/.gitbook/assets/full width button@2x.png and /dev/null differ diff --git a/.gitbook/assets/full width social button@2x (1).png b/.gitbook/assets/full width social button@2x (1).png deleted file mode 100644 index d25dbc7..0000000 Binary files a/.gitbook/assets/full width social button@2x (1).png and /dev/null differ diff --git a/.gitbook/assets/full width social button@2x.png b/.gitbook/assets/full width social button@2x.png deleted file mode 100644 index a1709c9..0000000 Binary files a/.gitbook/assets/full width social button@2x.png and /dev/null differ diff --git a/.gitbook/assets/fullwidth icon button@2x.png b/.gitbook/assets/fullwidth icon button@2x.png deleted file mode 100644 index 9f54a75..0000000 Binary files a/.gitbook/assets/fullwidth icon button@2x.png and /dev/null differ diff --git a/.gitbook/assets/fullwidth@2x.png b/.gitbook/assets/fullwidth@2x.png deleted file mode 100644 index d58c9c7..0000000 Binary files a/.gitbook/assets/fullwidth@2x.png and /dev/null differ diff --git a/.gitbook/assets/github-settings 2.png b/.gitbook/assets/github-settings 2.png deleted file mode 100644 index f92b36c..0000000 Binary files a/.gitbook/assets/github-settings 2.png and /dev/null differ diff --git a/.gitbook/assets/intro-screens-docs-banner-compressed (1) (1) (1).gif b/.gitbook/assets/intro-screens-docs-banner-compressed (1) (1) (1).gif deleted file mode 100644 index 78d8cad..0000000 Binary files a/.gitbook/assets/intro-screens-docs-banner-compressed (1) (1) (1).gif and /dev/null differ diff --git a/.gitbook/assets/Intro screens docs banner-compressed.gif b/.gitbook/assets/intro-screens-docs-banner-compressed (1).gif similarity index 100% rename from .gitbook/assets/Intro screens docs banner-compressed.gif rename to .gitbook/assets/intro-screens-docs-banner-compressed (1).gif diff --git a/.gitbook/assets/link share.png b/.gitbook/assets/link share.png deleted file mode 100644 index ac3ca68..0000000 Binary files a/.gitbook/assets/link share.png and /dev/null differ diff --git a/.gitbook/assets/outline 2x social button@2x (1).png b/.gitbook/assets/outline 2x social button@2x (1).png deleted file mode 100644 index c1adbb4..0000000 Binary files a/.gitbook/assets/outline 2x social button@2x (1).png and /dev/null differ diff --git a/.gitbook/assets/outline 2x social button@2x.png b/.gitbook/assets/outline 2x social button@2x.png deleted file mode 100644 index 2bc1d79..0000000 Binary files a/.gitbook/assets/outline 2x social button@2x.png and /dev/null differ diff --git a/.gitbook/assets/outline 2x@2x.png b/.gitbook/assets/outline 2x@2x.png deleted file mode 100644 index 2ca2e56..0000000 Binary files a/.gitbook/assets/outline 2x@2x.png and /dev/null differ diff --git a/.gitbook/assets/pills disabled@2x.png b/.gitbook/assets/pills disabled@2x.png deleted file mode 100644 index 2dc582d..0000000 Binary files a/.gitbook/assets/pills disabled@2x.png and /dev/null differ diff --git a/.gitbook/assets/pills icon button@2x.png b/.gitbook/assets/pills icon button@2x.png deleted file mode 100644 index f2d221f..0000000 Binary files a/.gitbook/assets/pills icon button@2x.png and /dev/null differ diff --git a/.gitbook/assets/pills outline 2x@2x.png b/.gitbook/assets/pills outline 2x@2x.png deleted file mode 100644 index 3c63f40..0000000 Binary files a/.gitbook/assets/pills outline 2x@2x.png and /dev/null differ diff --git a/.gitbook/assets/pills social buttons@2x.png b/.gitbook/assets/pills social buttons@2x.png deleted file mode 100644 index 5183b2c..0000000 Binary files a/.gitbook/assets/pills social buttons@2x.png and /dev/null differ diff --git a/.gitbook/assets/scaling@3x.png b/.gitbook/assets/scaling@3x.png deleted file mode 100644 index b44d839..0000000 Binary files a/.gitbook/assets/scaling@3x.png and /dev/null differ diff --git a/.gitbook/assets/size@3x.png b/.gitbook/assets/size@3x.png deleted file mode 100644 index 9b66401..0000000 Binary files a/.gitbook/assets/size@3x.png and /dev/null differ diff --git a/.gitbook/assets/slide@3x.png b/.gitbook/assets/slide@3x.png deleted file mode 100644 index ad6a09f..0000000 Binary files a/.gitbook/assets/slide@3x.png and /dev/null differ diff --git a/.gitbook/assets/slightly rounded corners@2x.png b/.gitbook/assets/slightly rounded corners@2x.png deleted file mode 100644 index a5e390e..0000000 Binary files a/.gitbook/assets/slightly rounded corners@2x.png and /dev/null differ diff --git a/.gitbook/assets/solid badge buttons@2x.png b/.gitbook/assets/solid badge buttons@2x.png deleted file mode 100644 index a813bf4..0000000 Binary files a/.gitbook/assets/solid badge buttons@2x.png and /dev/null differ diff --git a/.gitbook/assets/solid border.png b/.gitbook/assets/solid border.png deleted file mode 100644 index a0563db..0000000 Binary files a/.gitbook/assets/solid border.png and /dev/null differ diff --git a/.gitbook/assets/solid border@3x.png b/.gitbook/assets/solid border@3x.png deleted file mode 100644 index b37eded..0000000 Binary files a/.gitbook/assets/solid border@3x.png and /dev/null differ diff --git a/.gitbook/assets/solid button@2x.png b/.gitbook/assets/solid button@2x.png deleted file mode 100644 index bb0ddf2..0000000 Binary files a/.gitbook/assets/solid button@2x.png and /dev/null differ diff --git a/.gitbook/assets/solid social button@2x.png b/.gitbook/assets/solid social button@2x.png deleted file mode 100644 index 3448c59..0000000 Binary files a/.gitbook/assets/solid social button@2x.png and /dev/null differ diff --git a/.gitbook/assets/square icon button@2x.png b/.gitbook/assets/square icon button@2x.png deleted file mode 100644 index 193f542..0000000 Binary files a/.gitbook/assets/square icon button@2x.png and /dev/null differ diff --git a/.gitbook/assets/square social button@2x.png b/.gitbook/assets/square social button@2x.png deleted file mode 100644 index 8249d12..0000000 Binary files a/.gitbook/assets/square social button@2x.png and /dev/null differ diff --git a/.gitbook/assets/square solid@2x.png b/.gitbook/assets/square solid@2x.png deleted file mode 100644 index 90b23c3..0000000 Binary files a/.gitbook/assets/square solid@2x.png and /dev/null differ diff --git a/.gitbook/assets/square@2x.png b/.gitbook/assets/square@2x.png deleted file mode 100644 index 533449c..0000000 Binary files a/.gitbook/assets/square@2x.png and /dev/null differ diff --git a/.gitbook/assets/tabs@2x.png b/.gitbook/assets/tabs@2x.png deleted file mode 100644 index 231dcf2..0000000 Binary files a/.gitbook/assets/tabs@2x.png and /dev/null differ diff --git a/.gitbook/assets/tile with avatar@2x.png b/.gitbook/assets/tile with avatar@2x.png deleted file mode 100644 index 8c53c7f..0000000 Binary files a/.gitbook/assets/tile with avatar@2x.png and /dev/null differ diff --git a/.gitbook/assets/with image@2x.png b/.gitbook/assets/with image@2x.png deleted file mode 100644 index 9195cfa..0000000 Binary files a/.gitbook/assets/with image@2x.png and /dev/null differ diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..85d9240 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,25 @@ +name: Deploy production site + +on: + push: + branches: + - master + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: Navigate to repo + run: cd $GITHUB_WORKSPACE + - uses: actions/setup-node@v1 + with: + node-version: "10.x" + - name: Install deps + run: npm install + - name: Build docs + run: npm run build + - name: Publish + uses: cloudflare/wrangler-action@1.2.0 + with: + apiToken: ${{ secrets.APITOKEN }} diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..b58b603 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,5 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 0000000..a55e7a1 --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/docs.iml b/.idea/docs.iml new file mode 100644 index 0000000..24643cc --- /dev/null +++ b/.idea/docs.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..35d9096 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..6049cfe --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.npmignore b/.npmignore old mode 100644 new mode 100755 diff --git a/README.md b/README.md index f965b9b..fa1610e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ --- +image: 'https://ik.imagekit.io/ionicfirebaseapp/link-share_EbZz6yv3T.png' description: >- Flutter Development Docs by GetWidget is one of the largest Flutter open-source UI Kit libraries for mobile or web apps. It has more than 1000+ @@ -15,16 +16,21 @@ We are a huge follower of Flutter and using it from a very early stage ever sinc Flutter almost has all the widgets available that developers can use in projects but again, we used to develop lots of projects with flutter and hence decided why not develop all the possible widgets that can be reused in any project and speed up the app development. -We launched our UI Library in the beginning to develop a flutter app, to test the library component. Kindly give us your feedback to improve and add more widgets to our library. And if you are new then follow our this Flutter development doc with [GetWidget](https://www.getwidget.dev). These Flutter Docs will help you out to build the Flutter app faster. +We launched our UI Library in the beginning to develop a flutter app, to test the library component. Kindly give us your feedback to improve and add more widgets to our library. And if you are new then follow our this Flutter development doc with [GetWidget](https://www.getwidget.dev/). These Flutter Docs will help you out to build the Flutter app faster. ## Get Widget Roadmap We are committed to continuing this library development to make flutter app design & development less time consuming and with a small learning curve too. -We will really appreciate it if you could check our Roadmap and do Vote & share your Feedback on upcoming widgets and New features: [https://roadmap.getwidget.dev/](https://roadmap.getwidget.dev) +We will really appreciate it if you could check our Roadmap and do Vote & share your Feedback on upcoming widgets and New features: [https://roadmap.getwidget.dev/](https://roadmap.getwidget.dev/) Your support and feedback help us to build the best Flutter Open-Source product. ### XD Link:[https://xd.adobe.com/view/a23a7d02-b811-4d4e-b10a-b9c3d33eb50a-f769/grid/](https://xd.adobe.com/view/a23a7d02-b811-4d4e-b10a-b9c3d33eb50a-f769/grid/) -### [DOWNLOAD XD](https://drive.google.com/file/d/1vX7vT7soJS3weh7T8qWCTrmaA7\_C-tDH/view?usp=sharing) +### [DOWNLOAD XD](https://drive.google.com/file/d/1vX7vT7soJS3weh7T8qWCTrmaA7_C-tDH/view?usp=sharing) + +### + + + diff --git a/SUMMARY.md b/SUMMARY.md index b6d2fdd..6b652e1 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -11,11 +11,11 @@ * [GF Flutter RadioList Tile](src/gf-radio-listtile.md) * [GF Flutter Toast Widget](src/gf-toast.md) * [GF Flutter Alert Dialog](src/gf-alert.md) - * [GF Custom Flutter Carousel Widget](src/gf-carousel.md) + * [GF Flutter Carousel Widget](src/gf-carousel.md) * [GF Flutter Badge](src/gf-badge.md) * [GF Flutter Rating](src/gf-rating.md) * [Flutter Button Widget](src/gf-button/README.md) - * [Flutter Pills Button](src/gf-button/pills-button.md) + * [Flutter Pills/Rounded Button](src/gf-button/pills-button.md) * [Flutter Social Button](src/gf-button/social-button.md) * [Flutter Icon Button](src/gf-button/icon-button.md) * [Flutter Elevated Button](src/gf-button/standard-button.md) @@ -28,7 +28,7 @@ * [GF Flutter Progress Bar](src/gf-progress-bar.md) * [GF Flutter Appbar](src/gf-appbar.md) * [GF Flutter Drawer Widget](src/gf-drawer.md) - * [GF Custom Flutter Card](src/gf-card.md) + * [GF Flutter Card](src/gf-card.md) * [GF Flutter TabBar](src/gf-tab.md) * [GF Flutter Typography](src/gf-typography.md) * [GF Flutter ListTile](src/gf-tile.md) @@ -43,3 +43,4 @@ * [GF Flutter Dropdown](src/gf-dropdown.md) * [GF Flutter Multiselect](src/gf-multiselect.md) * [Flutter GetWidget Docs](src/index.md) + diff --git a/build/.cargo-ok b/build/.cargo-ok new file mode 100644 index 0000000..e69de29 diff --git a/build/.gitignore b/build/.gitignore new file mode 100644 index 0000000..75c573a --- /dev/null +++ b/build/.gitignore @@ -0,0 +1,2 @@ +node_modules +worker diff --git a/build/index.js b/build/index.js new file mode 100644 index 0000000..f980a77 --- /dev/null +++ b/build/index.js @@ -0,0 +1,80 @@ +import { getAssetFromKV, mapRequestToAsset } from '@cloudflare/kv-asset-handler' + +/** + * The DEBUG flag will do two things that help during development: + * 1. we will skip caching on the edge, which makes it easier to + * debug. + * 2. we will return an error message on exception in your Response rather + * than the default 404.html page. + */ +const DEBUG = false + +addEventListener('fetch', event => { + try { + event.respondWith(handleEvent(event)) + } catch (e) { + if (DEBUG) { + return event.respondWith( + new Response(e.message || e.toString(), { + status: 500, + }), + ) + } + event.respondWith(new Response('Internal Error', { status: 500 })) + } +}) + +async function handleEvent(event) { + const url = new URL(event.request.url) + let options = {} + + /** + * You can add custom logic to how we fetch your assets + * by configuring the function `mapRequestToAsset` + */ + // options.mapRequestToAsset = handlePrefix(/^\/docs/) + + try { + if (DEBUG) { + // customize caching + options.cacheControl = { + bypassCache: true, + } + } + return await getAssetFromKV(event, options) + } catch (e) { + // if an error is thrown try to serve the asset at 404.html + if (!DEBUG) { + try { + let notFoundResponse = await getAssetFromKV(event, { + mapRequestToAsset: req => new Request(`${new URL(req.url).origin}/404.html`, req), + }) + + return new Response(notFoundResponse.body, { ...notFoundResponse, status: 404 }) + } catch (e) {} + } + + return new Response(e.message || e.toString(), { status: 500 }) + } +} + +/** + * Here's one example of how to modify a request to + * remove a specific prefix, in this case `/docs` from + * the url. This can be useful if you are deploying to a + * route on a zone, or if you only want your static content + * to exist at a specific path. + */ +function handlePrefix(prefix) { + return request => { + // compute the default (e.g. / -> index.html) + let defaultAssetKey = mapRequestToAsset(request) + let url = new URL(defaultAssetKey.url) + + // strip the prefix from the path for lookup + url.pathname = url.pathname.replace(prefix, '/') + + // inherit all other props from the default request + return new Request(url.toString(), defaultAssetKey) + } +} \ No newline at end of file diff --git a/build/package.json b/build/package.json new file mode 100644 index 0000000..5dcaff5 --- /dev/null +++ b/build/package.json @@ -0,0 +1,12 @@ +{ + "private": true, + "name": "worker", + "version": "1.0.0", + "description": "A template for kick starting a Cloudflare Workers project", + "main": "index.js", + "author": "Ashley Lewis ", + "license": "MIT", + "dependencies": { + "@cloudflare/kv-asset-handler": "~0.0.11" + } +} diff --git a/package.json b/package.json old mode 100644 new mode 100755 index 724f5d1..c964e19 --- a/package.json +++ b/package.json @@ -1,30 +1,35 @@ { - "name": "getwidgt-documentation-site", + "name": "Get-Widget-Docs", "version": "0.0.1", - "description": "documentation of getwidget flutter library", + "description": "Get widget official documentation", "main": "index.js", "authors": { "name": "Aditya Koushik R", "email": "aditya@pietechsolution.com" }, - "repository": "/getwidgt-documentation-site", + "repository": "/Get-Widget-Docs", "scripts": { "dev": "vuepress dev src", - "build": "vuepress build src" + "build": "vuepress build src", + "deploy": "npm run build && wrangler publish" }, "license": "MIT", "devDependencies": { - "@vuepress/plugin-google-analytics": "^1.8.2", + "@mr-hope/vuepress-plugin-copy-code": "^1.19.1", + "@vuepress/plugin-back-to-top": "^1.5.4", + "@vuepress/plugin-google-analytics": "^1.6.0", + "@vuepress/plugin-pwa": "^1.5.4", "google-fonts-webpack-plugin": "^0.4.4", + "node-sass": "^4.14.1", + "sass-loader": "^10.0.2", "vuepress": "^1.5.3", - "vuepress-plugin-autometa": "^0.1.13", - "vuepress-plugin-clean-urls": "^1.1.2", - "webpack": "^4.45.0" + "vuepress-plugin-autometa": "^0.1.13" }, "dependencies": { - "@mr-hope/vuepress-plugin-copy-code": "^1.20.1", - "@vuepress/plugin-pwa": "^1.8.2", + "vue-router": "^3.4.4", + "vuepress-plugin-clean-urls": "1.1.1", "vuepress-plugin-img-lazy": "^1.0.4", - "vuepress-theme-book": "0.0.6" + "vuepress-theme-book": "0.0.4", + "@vuepress/plugin-google-analytics": "^1.6.0" } } diff --git a/src/.DS_Store b/src/.DS_Store new file mode 100644 index 0000000..1e702da Binary files /dev/null and b/src/.DS_Store differ diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js old mode 100644 new mode 100755 index f023646..7062d41 --- a/src/.vuepress/config.js +++ b/src/.vuepress/config.js @@ -1,424 +1,436 @@ const { description } = require('../../package') const default_options = { - enable: true, // enables/disables everything - control per page using frontmatter - image: true, // regular meta image used by search engines - twitter: true, // twitter card - og: true, // open graph: facebook, pinterest, google+ - schema: false, // schema.org for google + enable: true, // enables/disables everything - control per page using frontmatter + image: true, // regular meta image used by search engines + twitter: true, // twitter card + og: true, // open graph: facebook, pinterest, google+ + schema: false, // schema.org for google - author: { - name: 'getwidget', - twitter: '@getwidgetdev', - }, + author: { + name: 'getwidget', + twitter: '@getwidgetdev', + }, - // --------------------------------------------------------------------------- + // --------------------------------------------------------------------------- - site: { - name: 'getwidget', - twitter: '@getwidgetdev', - }, + site: { + name: 'getwidget', + twitter: '@getwidgetdev', + }, - description_sources: [ + description_sources: [ - 'frontmatter', - 'excerpt', + 'frontmatter', + 'excerpt', - // markdown paragraph regex - // - /^((?:(?!^#)(?!^\-|\+)(?!^[0-9]+\.)(?!^!\[.*?\]\((.*?)\))(?!^\[\[.*?\]\])(?!^\{\{.*?\}\})[^\n]|\n(?! *\n))+)(?:\n *)+\n/img, - // - // this excludes blockquotes using `(?!^>)` - ///^((?:(?!^#)(?!^\-|\+)(?!^[0-9]+\.)(?!^!\[.*?\]\((.*?)\))(?!^>)(?!^\[\[.*?\]\])(?!^\{\{.*?\}\})[^\n]|\n(?! *\n))+)(?:\n *)+\n/img, + // markdown paragraph regex + // + /^((?:(?!^#)(?!^\-|\+)(?!^[0-9]+\.)(?!^!\[.*?\]\((.*?)\))(?!^\[\[.*?\]\])(?!^\{\{.*?\}\})[^\n]|\n(?! *\n))+)(?:\n *)+\n/img, + // + // this excludes blockquotes using `(?!^>)` + ///^((?:(?!^#)(?!^\-|\+)(?!^[0-9]+\.)(?!^!\[.*?\]\((.*?)\))(?!^>)(?!^\[\[.*?\]\])(?!^\{\{.*?\}\})[^\n]|\n(?! *\n))+)(?:\n *)+\n/img, - // html paragraph regex - /(.*?)<\/p>/i, + // html paragraph regex + /(.*?)<\/p>/i, - ], + ], - // --------------------------------------------------------------------------- + // --------------------------------------------------------------------------- - // order of what gets the highest priority: - // - // 1. frontmatter - // 2. content markdown image such as `![alt text](http://url)` - // 3. content regular html img + // order of what gets the highest priority: + // + // 1. frontmatter + // 2. content markdown image such as `![alt text](http://url)` + // 3. content regular html img - image_sources: [ + image_sources: [ - 'frontmatter', + 'frontmatter', - /!\[.*?\]\((.*?)\)/i, // markdown image regex - /` - * - * ref:https://v1.vuepress.vuejs.org/config/#head - */ - head: [ - ['link', { rel: 'icon', href: 'https://ik.imagekit.io/ionicfirebaseapp/favicon_QkjfdlGz1.png' }], - ['meta', { name: 'theme-color', content: '#3eaf7c' }], - ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }], - ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }], - ['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com' }], - ['link', { rel: 'preload', href: 'https://fonts.googleapis.com/css2?family=Nunito+Sans:wght@600&display=swap' }], + /** + * Ref:https://v1.vuepress.vuejs.org/config/#title + */ + title: 'GetWidget', + /** + * Ref:https://v1.vuepress.vuejs.org/config/#description + */ + description: description, + theme: 'vuepress-theme-book', + /** + * Extra tags to be injected to the page HTML `` + * + * ref:https://v1.vuepress.vuejs.org/config/#head + */ + head: [ + ['link', { rel: 'icon', href: 'https://ik.imagekit.io/ionicfirebaseapp/favicon_QkjfdlGz1.png' }], + ['meta', { name: 'theme-color', content: '#3eaf7c' }], + ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }], + ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }], + ['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com' }], + ['link', { rel: 'preload', href: 'https://fonts.googleapis.com/css2?family=Nunito+Sans:wght@600&display=swap' }], - ], - evergreen: true, - theme: 'vuepress-theme-book', - /** - * Theme configuration, here is the default theme configuration for VuePress. - * - * ref:https://v1.vuepress.vuejs.org/theme/default-theme-config.html - */ - themeConfig: { - repo: '', - editLinks: true, - docsDir: '', - editLinkText: '', - lastUpdated: true, - parseHeaders: ['h2', 'h3'], - nav: [ - { text: 'Home', link: 'https://www.getwidget.dev/', target: 'blank' }, - { text: 'Blog', link: 'https://www.getwidget.dev/blog/', target: 'blank' }, - { text: 'Github', link: 'https://github.com/ionicfirebaseapp/getwidget', target: 'blank' }, - { text: 'FLUTTER APP KIT', link: 'https://market.getwidget.dev/products/', target: 'blank' }, ], - activeHeaderLinks: true, - sidebar: [ - { - title: 'Introduction', - path: '/', - collapsable: true, - children: [ - '/', - ], - }, - { - title: 'Getting started', - path: '/getting-started', - initialOpenGroupIndex: -1, - collapsable: true, - children: [ - '/getting-started' - ], - }, - { - title: 'GF Button', - path: '/gf-button', - initialOpenGroupIndex: -1, - collapsable: true, - children: [ - { title: 'Elevated Button', path: '/gf-button/standard-button' }, - { title: 'Pills Button', path: '/gf-button/pills-button' }, - { title: 'Square Button', path: '/gf-button/square-button' }, - { title: 'Icon Button', path: '/gf-button/icon-button' }, - { title: 'Social Button', path: '/gf-button/social-button' } - ] - }, - { - title: 'GF Badge', - initialOpenGroupIndex: -1, - collapsable: true, - path: '/gf-badge', - children: [ - '/gf-badge', - ], - }, - { - title: 'GF Avatar', - path: '/gf-avatar', - initialOpenGroupIndex: -1, - collapsable: true, - children: [ - '/gf-avatar', - ], - }, - { - title: 'GF Image', - path: '/gf-image', - collapsable: true, - children: [ - '/gf-image', - ], - }, - { - title: 'GF Card', - path: '/gf-card', - collapsable: true, - children: [ - '/gf-card', - ], - }, - { - title: 'GF Carousel', - path: '/gf-carousel', - collapsable: true, - children: [ - '/gf-carousel', - ], - }, - { - title: 'GF Tile', - path: '/gf-tile', - collapsable: true, - children: [ - '/gf-tile', - ], - }, - { - title: 'GF Tab', - path: '/gf-tab', - collapsable: true, - children: [ - '/gf-tab', - ], - }, - { - title: 'GF Floating Widget', - path: '/gf-floating-widget', - collapsable: true, - children: [ - '/gf-floating-widget', - ], - }, - { - title: 'GF Toast', - path: '/gf-toast', - collapsable: true, - children: [ - '/gf-toast', - ], - }, - { - title: 'GF Toggle', - path: '/gf-toggle', - collapsable: true, - children: [ - '/gf-toggle', - ], - }, - { - title: 'GF Typography', - path: '/gf-typography', - collapsable: true, - children: [ - '/gf-typography', - ], - }, - { - title: 'GF Drawer', - path: '/gf-drawer', - collapsable: true, - children: [ - '/gf-drawer', - ], - }, - { - title: 'GF Accordion', - path: '/gf-accordion', - collapsable: true, - children: [ - '/gf-accordion', - ], - }, - { - title: 'GF Alert', - path: '/gf-alert', - collapsable: true, - children: [ - '/gf-alert', - ], - }, - { - title: 'GF Appbar', - path: '/gf-appbar', - collapsable: true, - children: [ - '/gf-appbar', - ], - }, - { - title: 'GF Searchbar', - path: '/gf-searchbar', - collapsable: true, - children: [ - '/gf-searchbar', - ], - }, - { - title: 'GF Rating', - path: '/gf-rating', - collapsable: true, - children: [ - '/gf-rating', - ], - }, - { - title: 'GF Dropdown', - path: '/gf-dropdown', - collapsable: true, - children: [ - '/gf-dropdown', - ], - }, - { - title: 'GF Loader', - path: '/gf-loader', - collapsable: true, - children: [ - '/gf-loader', - ], - }, - { - title: 'GF Progress Bar', - path: '/gf-progress-bar', - collapsable: true, - children: [ - '/gf-progress-bar', - ], - }, - { - title: 'GF Shimmer', - path: '/gf-shimmer', - collapsable: true, - children: [ - '/gf-shimmer', - ], - }, - { - title: 'GF Animation', - path: '/gf-animation', - collapsable: true, - children: [ - '/gf-animation', - ], - }, - { - title: 'GF Border', - path: '/gf-border', - collapsable: true, - children: [ - '/gf-border', - ], - }, - { - title: 'GF Bottom Sheet', - path: '/gf-bottomsheet', - collapsable: true, - children: [ - '/gf-bottomsheet', - ], - }, - { - title: 'GF Checkbox', - path: '/gf-checkbox', - collapsable: true, - children: [ - '/gf-checkbox', - ], - }, - { - title: 'GF Checkbox ListTile', - path: '/gf-checkbox-listtile', - collapsable: true, - children: [ - '/gf-checkbox-listtile', - ], - }, - { - title: 'GF MultiSelect', - path: '/gf-multiselect', - collapsable: true, - children: [ - '/gf-multiselect', - ], - }, - { - title: 'GF IntroScreen', - path: '/gf-intro-screen', - collapsable: true, - children: [ - '/gf-intro-screen', - ], - }, - { - title: 'GF Radio', - path: '/gf-radio', - collapsable: true, - children: [ - '/gf-radio', - ], - }, - { - title: 'GF Radio ListTile', - path: '/gf-radio-listtile', - collapsable: true, - children: [ - '/gf-radio-listtile', - ], - }, - { - title: 'GF Sticky Header', - path: '/gf-sticky-header', - collapsable: true, - children: [ - '/gf-sticky-header', - ], - }, + /** + * Theme configuration, here is the default theme configuration for VuePress. + * + * ref:https://v1.vuepress.vuejs.org/theme/default-theme-config.html + */ + themeConfig: { + repo: '', + editLinks: true, + docsDir: '', + editLinkText: '', + lastUpdated: true, + parseHeaders: ['h2', 'h3'], + nav: [ + { text: 'Home', link: 'https://www.getwidget.dev/', target: 'blank' }, + { text: 'Blog', link: 'https://www.getwidget.dev/blog/', target: 'blank' }, + { text: 'Github', link: 'https://github.com/ionicfirebaseapp/getwidget', target: 'blank' }, + { text: 'FLUTTER APP KIT', link: 'https://market.getwidget.dev/products/', target: 'blank' }, + ], + activeHeaderLinks: true, + sidebar: [ + { + title: 'Introduction', + path: '/', + collapsable: true, + children: [ + '/', + ], + }, + { + title: 'Getting started', + path: '/getting-started', + initialOpenGroupIndex: -1, + collapsable: true, + children: [ + '/getting-started' - { - title: 'Changelog', - path: '/changelog', - collapsable: true, - children: [ - '/changelog', - ], - }, - { - title: 'Flutter UI KIT Market', - path: 'https://market.getwidget.dev/products/', - target: 'blank', - collapsable: false - }, - ], - }, + ], + }, + { + title: 'GF Button', + path: '/gf-button', + initialOpenGroupIndex: -1, + collapsable: true, + children: [ + { title: 'Elevated Button', path: '/gf-button/standard-button' }, + { title: 'Pills Button', path: '/gf-button/pills-button' }, + { title: 'Square Button', path: '/gf-button/square-button' }, + { title: 'Icon Button', path: '/gf-button/icon-button' }, + { title: 'Social Button', path: '/gf-button/social-button' } + ] + }, + + // { + // title: 'GF Badge', + // path: '/gf-badge', + // initialOpenGroupIndex: -1, + // collapsable: true, + + // }, + { + title: 'GF Badge', + initialOpenGroupIndex: -1, + collapsable: true, + path: '/gf-badge', + children: [ + '/gf-badge', + ], + }, + + + + { + title: 'GF Avatar', + path: '/gf-avatar', + initialOpenGroupIndex: -1, + collapsable: true, + children: [ + '/gf-avatar', + ], + }, - /** - * Apply plugins,ref:https://v1.vuepress.vuejs.org/zh/plugin/ - */ - plugins: [ - '@vuepress/plugin-back-to-top', - '@vuepress/plugin-medium-zoom', - ['vuepress-plugin-clean-urls', - { - normalSuffix: '/', - indexSuffix: '/', - notFoundPath: '/404.html', - }, + + + { + title: 'GF Image', + path: '/gf-image', + collapsable: true, + children: [ + '/gf-image', + ], + }, + { + title: 'GF Card', + path: '/gf-card', + collapsable: true, + children: [ + '/gf-card', + ], + }, + { + title: 'GF Carousel', + path: '/gf-carousel', + collapsable: true, + children: [ + '/gf-carousel', + ], + }, + { + title: 'GF Tile', + path: '/gf-tile', + collapsable: true, + children: [ + '/gf-tile', + ], + }, + { + title: 'GF Tab', + path: '/gf-tab', + collapsable: true, + children: [ + '/gf-tab', + ], + }, + { + title: 'GF Floating Widget', + path: '/gf-floating-widget', + collapsable: true, + children: [ + '/gf-floating-widget', + ], + }, + { + title: 'GF Toast', + path: '/gf-toast', + collapsable: true, + children: [ + '/gf-toast', + ], + }, + { + title: 'GF Toggle', + path: '/gf-toggle', + collapsable: true, + children: [ + '/gf-toggle', + ], + }, + { + title: 'GF Typography', + path: '/gf-typography', + collapsable: true, + children: [ + '/gf-typography', + ], + }, + { + title: 'GF Drawer', + path: '/gf-drawer', + collapsable: true, + children: [ + '/gf-drawer', + ], + }, + { + title: 'GF Accordion', + path: '/gf-accordion', + collapsable: true, + children: [ + '/gf-accordion', + ], + }, + { + title: 'GF Alert', + path: '/gf-alert', + collapsable: true, + children: [ + '/gf-alert', + ], + }, + { + title: 'GF Appbar', + path: '/gf-appbar', + collapsable: true, + children: [ + '/gf-appbar', + ], + }, + { + title: 'GF Searchbar', + path: '/gf-searchbar', + collapsable: true, + children: [ + '/gf-searchbar', + ], + }, + { + title: 'GF Rating', + path: '/gf-rating', + collapsable: true, + children: [ + '/gf-rating', + ], + }, + { + title: 'GF Dropdown', + path: '/gf-dropdown', + collapsable: true, + children: [ + '/gf-dropdown', + ], + }, + { + title: 'GF Loader', + path: '/gf-loader', + collapsable: true, + children: [ + '/gf-loader', + ], + }, + { + title: 'GF Progress Bar', + path: '/gf-progress-bar', + collapsable: true, + children: [ + '/gf-progress-bar', + ], + }, + { + title: 'GF Shimmer', + path: '/gf-shimmer', + collapsable: true, + children: [ + '/gf-shimmer', + ], + }, + { + title: 'GF Animation', + path: '/gf-animation', + collapsable: true, + children: [ + '/gf-animation', + ], + }, + { + title: 'GF Border', + path: '/gf-border', + collapsable: true, + children: [ + '/gf-border', + ], + }, + { + title: 'GF Bottom Sheet', + path: '/gf-bottomsheet', + collapsable: true, + children: [ + '/gf-bottomsheet', + ], + }, + + { + title: 'GF Checkbox ListTile', + path: '/gf-checkbox-listtile', + collapsable: true, + children: [ + '/gf-checkbox-listtile', + ], + }, + { + title: 'GF Checkbox', + path: '/gf-checkbox', + collapsable: true, + children: [ + '/gf-checkbox', + ], + }, + { + title: 'GF IntroScreen', + path: '/gf-intro-screen', + collapsable: true, + children: [ + '/gf-intro-screen', + ], + }, + { + title: 'GF Radio ListTile', + path: '/gf-radio-listtile', + collapsable: true, + children: [ + '/gf-radio-listtile', + ], + }, + { + title: 'GF Radio', + path: '/gf-radio', + collapsable: true, + children: [ + '/gf-radio', + ], + }, + { + title: 'GF Sticky Header', + path: '/gf-sticky-header', + collapsable: true, + children: [ + '/gf-sticky-header', + ], + }, + + { + title: 'Changelog', + path: '/changelog', + collapsable: true, + children: [ + '/changelog', + ], + }, + { + title: 'Flutter UI KIT Market', + path: 'https://market.getwidget.dev/products/', + target: 'blank', + collapsable: false + }, + ], + }, + + /** + * Apply plugins,ref:https://v1.vuepress.vuejs.org/zh/plugin/ + */ + plugins: [ + '@vuepress/plugin-back-to-top', + '@vuepress/plugin-medium-zoom', + ['vuepress-plugin-clean-urls', + { + normalSuffix: '/', + indexSuffix: '/', + notFoundPath: '/404.html', + }, + ], + 'img-lazy', + [ + '@vuepress/google-analytics', + { + ga: 'UA-165669152-1' + } + ], + ['autometa', default_options], + [ + "@mr-hope/copy-code", + { + showInMobile: true + }, + ] ], - 'img-lazy', - ['autometa', default_options], - [ - "@mr-hope/copy-code", - { - showInMobile: true - }, - ] - ], } diff --git a/src/.vuepress/enhanceApp.js b/src/.vuepress/enhanceApp.js old mode 100644 new mode 100755 index 8452a86..aa124c8 --- a/src/.vuepress/enhanceApp.js +++ b/src/.vuepress/enhanceApp.js @@ -4,6 +4,7 @@ * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements */ + export default ({ Vue, // the version of Vue being used in the VuePress app options, // the options for the root Vue instance diff --git a/src/.vuepress/public/favicon.png b/src/.vuepress/public/favicon.png new file mode 100644 index 0000000..c145e84 Binary files /dev/null and b/src/.vuepress/public/favicon.png differ diff --git a/src/.vuepress/styles/index.styl b/src/.vuepress/styles/index.styl old mode 100644 new mode 100755 diff --git a/src/.vuepress/styles/palette.styl b/src/.vuepress/styles/palette.styl old mode 100644 new mode 100755 diff --git a/src/changelog.md b/src/changelog.md index 9e28435..b816e4e 100644 --- a/src/changelog.md +++ b/src/changelog.md @@ -1,5 +1,7 @@ --- +sidebarDepth: 2 description: Get flutter Changelog +canonicalUrl: https://docs.getwidget.dev/changelog --- # Changelog @@ -14,11 +16,11 @@ description: Get flutter Changelog **Added** -* added new component +* added new component - * GFProgressBar + * GFProgressBar - \*\*\*\* + \*\*\*\* ### **1.0.7 - 2020-02-11** @@ -149,3 +151,4 @@ Added few new components #### Added * initial release with buttons, badge, card, list tile, avatar and many more components. + diff --git a/src/getting-started.md b/src/getting-started.md index 6eb1b49..71f30bd 100644 --- a/src/getting-started.md +++ b/src/getting-started.md @@ -1,7 +1,12 @@ --- +title: Getting Started With GetWidget +sidebarDepth: 2 description: >- Flutter Tutorial with Getwidget step by step tutorial guide on how to get started and use it in any flutter app or web app project. +image: >- + https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Accordion_UXKLspZ4L.png +canonicalUrl: https://docs.getwidget.dev/getting-started --- # Flutter Tutorial with Getwidget @@ -12,7 +17,7 @@ Add the following dependency into your pubspec.yaml file ```dart dependencies: - getwidget: ^2.0.4 + getwidget: ^2.0.3 ``` You can install the above dependency by running the following code @@ -38,3 +43,4 @@ Now in your Dart code, you can import the components that are necessary for your ```dart import 'package:getwidget/getwidget.dart'; ``` + diff --git a/src/gf-accordion.md b/src/gf-accordion.md index 093c64c..007a19c 100644 --- a/src/gf-accordion.md +++ b/src/gf-accordion.md @@ -1,9 +1,10 @@ --- -title: How to Create Flutter Accordion Widget Design with Example Code +sidebarDepth: 2 description: >- GF Flutter Accordion expands or collapses the view of its children when it is tapped. GFAccordion is used to collapse and expand the content to view the messages. +canonicalUrl: https://docs.getwidget.dev/gf-accordion --- # GF Flutter Accordion @@ -12,9 +13,9 @@ description: >- **Flutter Accordion** is an expansion tile wherein the **content** or the **body** of the **title** will be hidden or **collapsed** and it will be expanded only when clicking the title of the **expansion tile**. The content can be of any widget and can have any number of lines. The **dropdown** **arrow** shows whether the tile is expanded or collapsed according to the need. -## GF Flutter Accordion and its Usage: +### GF Flutter Accordion and its Usage: -**GFAccordion** is a **Flutter Accordion** that is an expansion tile wherein the **content** or the **body** of the **title** will be **hidden** or **collapsed** and it will be expanded only when clicking the title of the **expansion tile**. The content can be of any **widget** and can have any number of lines. The **dropdown** **arrow** shows whether the tile is expanded or collapsed according to the need. +**GFAccordion** is a **Flutter Accordion** that is an expansion tile wherein the **content** or the **body** of the **title** will be **hidden** or **collapsed** and it will be expanded only when clicking the title of the **expansion tile**. The content can be of any **widget** and can have any number of lines. The **dropdown** **arrow** shows whether the tile is expanded or collapsed according to the need. **GFAccordion** has a simple **title** and its **content** as arguments and it can also be customized. Now let us take a look at a simple code of **GFAccordion** @@ -27,7 +28,7 @@ GFAccordion( ) ``` -## Flutter Accordion with Icon +### Flutter Accordion with Icon ![Flutter Accordion with Icon](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/accordion-with-icon-2x_zWtnsZQmZ.png) @@ -46,7 +47,7 @@ GFAccordion( ), ``` -## Flutter Accordion with trailing Text +### Flutter Accordion with trailing Text ![Flutter Accordion with trailing text](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/accordian-with-text-2x_zitIBS6DI_FMr8uWr38.png) @@ -65,28 +66,29 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## GF Accordion Custom Properties +### GF Accordion Custom Properties A simple **GFAccordion** can be customized according to the need and hence there are other custom properties that are listed below: -| Name | Description | -| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| **showAccordion** | controls if the accordion should be collapsed or not making it possible to be controlled from outside | -| **titleChild** | child of type \[Widget]is an alternative to the title key. the title will get priority over titleChild | -| **content** | content of type\[String] which shows the messages after the \[GFAccordion] is expanded | -| **contentChild** | contentChild of type \[Widget]is an alternative to the content key. content will get priority over the contentChild | -| **collapsedTitleBackgroundColor** | type of \[Color] or \[GFColors] which is used to change the background color of the \[GFAccordion] title when it is collapsed | -| **expandedTitleBackgroundColor** | type of \[Color] or \[GFColors] which is used to change the background color of the \[GFAccordion] title when it is expanded | -| **collapsedIcon** | collapsedIcon of type \[Widget] which is used to show when the \[GFAccordion] is collapsed | -| **expandedIcon** | expandedIcon of type\[Widget] which is used when the \[GFAccordion] is expanded | -| **title** | text of type \[String] is alternative to the child. text will get priority over titleChild | -| **textStyle** | textStyle of type \[textStyle] will be applicable to text only and not for the child | -| **titlePadding** | titlePadding of type \[EdgeInsets] which is used to set the padding of the \[GFAccordion] title | -| **contentPadding** | descriptionPadding of type \[EdgeInsets] which is used to set the padding of the \[GFAccordion] description | -| **contentBackgroundColor** | type of \[Color] or \[GFColors] which is used to change the background color of the \[GFAccordion] description | -| **margin** | margin of type \[EdgeInsets] which is used to set the margin of the \[GFAccordion] | -| **titleBorder** | titleBorderColor of type \[Color] or \[GFColors] which is used to change the border color of the title | -| **contentBorder** | contentBorderColor of type \[Color] or \[GFColors] which is used to change the border color of the content | -| **titleBorderRadius** | titleBorderRadius of type \[Radius] which is used to change the border radius of title | -| **contentBorderRadius** | contentBorderRadius of type \[Radius] which is used to change the border radius of content | -| **onToggleCollapsed** | function called when the content body collapsed | +| Name | Description | +| :--- | :--- | +| **showAccordion** | controls if the accordion should be collapsed or not making it possible to be controlled from outside | +| **titleChild** | child of type \[Widget\]is an alternative to the title key. the title will get priority over titleChild | +| **content** | content of type\[String\] which shows the messages after the \[GFAccordion\] is expanded | +| **contentChild** | contentChild of type \[Widget\]is an alternative to the content key. content will get priority over the contentChild | +| **collapsedTitleBackgroundColor** | type of \[Color\] or \[GFColors\] which is used to change the background color of the \[GFAccordion\] title when it is collapsed | +| **expandedTitleBackgroundColor** | type of \[Color\] or \[GFColors\] which is used to change the background color of the \[GFAccordion\] title when it is expanded | +| **collapsedIcon** | collapsedIcon of type \[Widget\] which is used to show when the \[GFAccordion\] is collapsed | +| **expandedIcon** | expandedIcon of type\[Widget\] which is used when the \[GFAccordion\] is expanded | +| **title** | text of type \[String\] is alternative to the child. text will get priority over titleChild | +| **textStyle** | textStyle of type \[textStyle\] will be applicable to text only and not for the child | +| **titlePadding** | titlePadding of type \[EdgeInsets\] which is used to set the padding of the \[GFAccordion\] title | +| **contentPadding** | descriptionPadding of type \[EdgeInsets\] which is used to set the padding of the \[GFAccordion\] description | +| **contentBackgroundColor** | type of \[Color\] or \[GFColors\] which is used to change the background color of the \[GFAccordion\] description | +| **margin** | margin of type \[EdgeInsets\] which is used to set the margin of the \[GFAccordion\] | +| **titleBorder** | titleBorderColor of type \[Color\] or \[GFColors\] which is used to change the border color of the title | +| **contentBorder** | contentBorderColor of type \[Color\] or \[GFColors\] which is used to change the border color of the content | +| **titleBorderRadius** | titleBorderRadius of type \[Radius\] which is used to change the border radius of title | +| **contentBorderRadius** | contentBorderRadius of type \[Radius\] which is used to change the border radius of content | +| **onToggleCollapsed** | function called when the content body collapsed | + diff --git a/src/gf-alert.md b/src/gf-alert.md index 08a8720..a02c163 100644 --- a/src/gf-alert.md +++ b/src/gf-alert.md @@ -1,19 +1,22 @@ --- +sidebarDepth: 2 description: >- GF Flutter alert Dialog widget is used to show some information and wait for - the user's action.GF alert comes with 100+ Custom properties like Basic, Full + the user's action.GF alter comes with 100+ Custom properties like Basic, Full width, and round custom alert. +canonicalUrl: https://docs.getwidget.dev/gf-alert + --- # GF Flutter Alert Dialog ![GF Flutter AlertDialog Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Alerts_lGAx_wQkf.png) -## GF Flutter AlertDialog and its Usage +### GF Flutter AlertDialog and its Usage **GFAlert** is a **Flutter Alert Dialog** that shows upon clicking the relevant button that gives some kind of information or messages and it apparently has some action buttons. -**GF Flutter Alert Dialog** should be wrapped inside the **GFFloating** Widget. The **child** of the **GFFloatingWidget** takes **GFAlert** as its argument and the **body** takes any kind of widgets. +**GF Flutter Alert Dialog** should be wrapped inside the **GFFloating** Widget. The **child** of the **GFFloatingWidget** takes **GFAlert** as its argument and the **body** takes any kind of widgets. The **Flutter Alert Dialog** example code is as shown below. @@ -93,13 +96,13 @@ Scaffold( ), ``` -## Flutter Alert Dialog with multiple buttons +### Flutter Alert Dialog with multiple buttons ![Flutter Dialog Alert with multiple buttons](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/alert-with-multiple-buttons-2x_Shkug_oIA_mgJmFTzcS.png) **GFAlert** can have two or more buttons for call of action in the **bottombar** of the **alert** widget. -The code below shows the multiple buttons Dialog Alert Button. + The code below shows the multiple buttons Dialog Alert Button. ```dart import 'package:getwidget/getwidget.dart'; @@ -141,7 +144,7 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## Flutter AlertDialog Type +### Flutter AlertDialog Type There are three types of **alerts** ie, `basic` , `rounded` and `fullWidth` . The default alert is a basic alert. The below code shows the **rounded** alert. For **fullWidth** alert replace **rounded** with **fullWidth.** @@ -186,7 +189,7 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## Flutter Dialog Alert Positioning +### Flutter Dialog Alert Positioning **GFAlerts** can be positioned accordingly inside the **GFFloating** Widget. The positioning takes two parameters ie, **horizontalPosition** and **verticalPosition**. The usage of these is shown below. @@ -203,16 +206,17 @@ body:GFFloatingWidget( ) ``` -## GF Flutter AlertDialog Custom Properties +### GF Flutter AlertDialog Custom Properties The look and feel of the **GFAlert** can be customized using the following properties -| Name | Description | -| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| **child** | **child** of type \[Widget] which is alternative to **title**. **title** will get priority over **child** | -| **contentChild** | **contentchild** of type \[Widget] which is alternative to **content**. **content** will get priority over **contentchild** | -| **titleTextStyle** | changes the style of the **title** not for the **child** | -| **backgroundColor** | used to change the backgroundColor of the GFAlert | -| **contentTextStyle** | changes the style of the **content** not for the **contentChild** | -| **width** | used to control the width of the **Alert** | -| **alignment** | used to align the **title or content** to desired position | +| Name | Description | +| :--- | :--- | +| **child** | **child** of type \[Widget\] which is alternative to **title**. **title** will get priority over **child** | +| **contentChild** | **contentchild** of type \[Widget\] which is alternative to **content**. **content** will get priority over **contentchild** | +| **titleTextStyle** | changes the style of the **title** not for the **child** | +| **backgroundColor** | used to change the backgroundColor of the GFAlert | +| **contentTextStyle** | changes the style of the **content** not for the **contentChild** | +| **width** | used to control the width of the **Alert** | +| **alignment** | used to align the **title or content** to desired position | + diff --git a/src/gf-animation.md b/src/gf-animation.md index 762fed9..f923ee9 100644 --- a/src/gf-animation.md +++ b/src/gf-animation.md @@ -6,15 +6,15 @@ description: >- # GF Flutter Animation -![GF Flutter Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation_docs_banner_A\_10aeESdCUL.gif) +![GF Flutter Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation_docs_banner_A_10aeESdCUL.gif) **GFAnimation** is a **Flutter Animation** wherein it makes the UI smooth for the user and the user interaction with the app will be easier. **GFAnimation** makes it easy to implement a variety of animations. ## GF Flutter Animation Type : -### 1. GF Flutter Rotation Animation +### 1. GF Flutter Rotation Animation -**GFAnimation** property `type: GFAnimationType.rotateTransition` , creates a rotation transition for the child of type widget. This type of animation will animate the rotation of a widget. +**GFAnimation** property `type: GFAnimationType.rotateTransition` , creates a rotation transition for the child of type widget. This type of animation will animate the rotation of a widget. The below example code shows the **Flutter rotation animation**. @@ -53,9 +53,9 @@ GestureDetector( ### 2. GF Flutter Animation Scaling -**GFAnimation** property `type: GFAnimationType.scaleTransition` , creates a scale transition for the child of type widget. It animates the scale of a transformed widget. The below code shows the **flutter scale animation**. +**GFAnimation** property `type: GFAnimationType.scaleTransition` , creates a scale transition for the child of type widget. It animates the scale of a transformed widget. The below code shows the **flutter scale animation**. -![GF Flutter Scaling Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation\_-scaling_xKsfUBwdY.gif) +![GF Flutter Scaling Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation_-scaling_xKsfUBwdY.gif) ```dart late AnimationController controller; @@ -89,9 +89,9 @@ GestureDetector( ### 3. GF Flutter Animation Alignment -![GF Flutter Alignment Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation-\_allignment\_1NU1fAmgT.gif) +![GF Flutter Alignment Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation-_allignment_1NU1fAmgT.gif) -**GFAnimation** property `type: GFAnimationType.align` , creates an alignment transition for the child of type widget. Animates the position alignment of a widget over a given duration whenever alignment changes. The below gives alignment type of animation +**GFAnimation** property `type: GFAnimationType.align` , creates an alignment transition for the child of type widget. Animates the position alignment of a widget over a given duration whenever alignment changes. The below gives alignment type of animation ```dart GFAnimation( @@ -108,9 +108,9 @@ GFAnimation( ### 4.GF Flutter Page Slide Transition -![GF Flutter Page Slide Transition](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation-\_slide_pCBzSV31Bgt.gif) +![GF Flutter Page Slide Transition](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation-_slide_pCBzSV31Bgt.gif) -**GFAnimation** property `type: GFAnimationType.slideTransition` , creates a fractional translation transitions for the child of type widget. Animates the position of a widget relative to its normal position. The below codes shows the example of **flutter page slide transition** animation. +**GFAnimation** property `type: GFAnimationType.slideTransition` , creates a fractional translation transitions for the child of type widget. Animates the position of a widget relative to its normal position. The below codes shows the example of **flutter page slide transition** animation. ```dart late Animation offsetAnimation; @@ -149,7 +149,7 @@ Container( ![Flutter Size Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation-size_Uo3LU0xmy.gif) -**GFAnimation** property `type: GFAnimationType.size` , creates a widget that animates its size. Animates the widget that automatically transitions its size in a given duration whenever the given child's size changes. The example below demonstrates the **Text** **size animation in flutter**. +**GFAnimation** property `type: GFAnimationType.size` , creates a widget that animates its size. Animates the widget that automatically transitions its size in a given duration whenever the given child's size changes. The example below demonstrates the **Text** **size animation in flutter**. ```dart bool selected = false; @@ -190,7 +190,7 @@ GFAnimation( ![GF Flutter Animation Container](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Animation-container_vGQhL26sk.gif) -**GFAnimation** property `type: GFAnimationType.container` , creates a widget gives the zooming effect. Animates the widget that automatically zooms in and out in a given duration whenever the given child's size changes. The below example shows the effect of animation. +**GFAnimation** property `type: GFAnimationType.container` , creates a widget gives the zooming effect. Animates the widget that automatically zooms in and out in a given duration whenever the given child's size changes. The below example shows the effect of animation. ```dart late AnimationController controller; @@ -227,33 +227,34 @@ GFAnimation( The look and feel of the **GFAnimation** can be customized using the GFAnimation properties. -| Name | Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **duration** | The duration for animation to perform | -| **reverseDuration** | The duration for reverse animation to perform | -| **alignment** | Defines how the animated widget is aligned during Animation. | -| **activeAlignment** | Defines how the animated widget is aligned(after the onTap) during Animation. | -| **child** | The child of type \[Widget] to display animation effect. | -| **curve** | Determines the animation curve. Defaults to \[Curves.linear]. | -| **type** | type of \[GFAnimation] which takes the type ie, align, size, container, rotateTransition, scaleTransition, slideTransition, and textStyle for the \[GFAnimation] | -| **width** | defines \[AnimatedContainer] initial width | -| **changedWidth** | defines the width of \[AnimatedContainer] upto which it can expand during animation | -| **height** | defines \[AnimatedContainer] initial height | -| **changedHeight** | defines the height of \[AnimatedContainer] upto which it can expand during animation | -| **activeColor** | defines the color of \[AnimatedContainer] when onTap triggers | -| **color** | defines the color of \[AnimatedContainer] | -| **padding** | defines \[child]'s or \[AnimatedContainer] padding | -| **margin** | defines \[child]'s or \[AnimatedContainer] margin | -| **onTap** | Called when the user taps the \[child] | -| **turnsAnimation** | For GFAnimationType.rotateTransition, customized turns animation can be added to \[RotationTransition] widget | -| **scaleAnimation** | For GFAnimationType.scaleTransition, customized scale animation can be added to \[ScaleTransition] widget | -| **controller** | Type of \[AnimationController], its a controller of an animation. | -| **textDirection** | Defines direction of the \[AnimatedDefaultTextStyle] TextDirection i.e \[ltr,rtl] | -| **slidePosition** | For GFAnimationType.slideTransition, which animates the position of a widget. | -| **style** | Defines the \[TextStyle] of \[AnimatedDefaultTextStyle] | -| **textAlign** | Defines the \[TextAlign] of \[AnimatedDefaultTextStyle] | -| **textOverflow** | Defines the \[TextOverflow] of \[AnimatedDefaultTextStyle] | -| **maxLines** | Defines the \[maxLines] of \[AnimatedDefaultTextStyle] | -| **textWidthBasis** | Defines the \[TextWidthBasis] of \[AnimatedDefaultTextStyle] | -| **fontSize** | Defines the \[fontSize] of \[AnimatedDefaultTextStyle] | -| **fontWeight** | Defines the \[fontWeight] of \[AnimatedDefaultTextStyle] | +| Name | Description | +| :--- | :--- | +| **duration** | The duration for animation to perform | +| **reverseDuration** | The duration for reverse animation to perform | +| **alignment** | Defines how the animated widget is aligned during Animation. | +| **activeAlignment** | Defines how the animated widget is aligned\(after the onTap\) during Animation. | +| **child** | The child of type \[Widget\] to display animation effect. | +| **curve** | Determines the animation curve. Defaults to \[Curves.linear\]. | +| **type** | type of \[GFAnimation\] which takes the type ie, align, size, container, rotateTransition, scaleTransition, slideTransition, and textStyle for the \[GFAnimation\] | +| **width** | defines \[AnimatedContainer\] initial width | +| **changedWidth** | defines the width of \[AnimatedContainer\] upto which it can expand during animation | +| **height** | defines \[AnimatedContainer\] initial height | +| **changedHeight** | defines the height of \[AnimatedContainer\] upto which it can expand during animation | +| **activeColor** | defines the color of \[AnimatedContainer\] when onTap triggers | +| **color** | defines the color of \[AnimatedContainer\] | +| **padding** | defines \[child\]'s or \[AnimatedContainer\] padding | +| **margin** | defines \[child\]'s or \[AnimatedContainer\] margin | +| **onTap** | Called when the user taps the \[child\] | +| **turnsAnimation** | For GFAnimationType.rotateTransition, customized turns animation can be added to \[RotationTransition\] widget | +| **scaleAnimation** | For GFAnimationType.scaleTransition, customized scale animation can be added to \[ScaleTransition\] widget | +| **controller** | Type of \[AnimationController\], its a controller of an animation. | +| **textDirection** | Defines direction of the \[AnimatedDefaultTextStyle\] TextDirection i.e \[ltr,rtl\] | +| **slidePosition** | For GFAnimationType.slideTransition, which animates the position of a widget. | +| **style** | Defines the \[TextStyle\] of \[AnimatedDefaultTextStyle\] | +| **textAlign** | Defines the \[TextAlign\] of \[AnimatedDefaultTextStyle\] | +| **textOverflow** | Defines the \[TextOverflow\] of \[AnimatedDefaultTextStyle\] | +| **maxLines** | Defines the \[maxLines\] of \[AnimatedDefaultTextStyle\] | +| **textWidthBasis** | Defines the \[TextWidthBasis\] of \[AnimatedDefaultTextStyle\] | +| **fontSize** | Defines the \[fontSize\] of \[AnimatedDefaultTextStyle\] | +| **fontWeight** | Defines the \[fontWeight\] of \[AnimatedDefaultTextStyle\] | + diff --git a/src/gf-appbar.md b/src/gf-appbar.md index bd08f0c..5c5e8d9 100644 --- a/src/gf-appbar.md +++ b/src/gf-appbar.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter appbar is a top action bar or a top action button that has a dedicated space with visual structure and interactive elements. @@ -16,13 +17,13 @@ description: >- ## GF Flutter Appbar and its Usage: -A **GFAppBar** is a **Flutter AppBar** widget that consists of a toolbar and potentially other widgets, such as a GFTabBar and FlexibleSpaceBar. The **GFAppBar** displays the toolbar widgets, **leading**, **title**, and **actions.** +A **GFAppBar** is a **Flutter AppBar** widget that consists of a toolbar and potentially other widgets, such as a GFTabBar and FlexibleSpaceBar. The **GFAppBar** displays the toolbar widgets, **leading**, **title**, and **actions.** **GFAppbar** has a **menu icon button** or **flutter appbar icon** on the top left corner that can be changed according to the need. The **leading appbar button** parameter is used to change the default menu icon button. -The below example code shows a simple appbar **\*\*with a **flutter appbar back button** on the **leading parameter\*\* which is used to go back to the previous page. +The below example code shows a simple appbar ****with a **flutter appbar back button** on the **leading parameter** which is used to go back to the previous page. -![Flutter Appbar with back button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/BAsic\_3x_cbGIPYmQJ.png) +![Flutter Appbar with back button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/BAsic_3x_cbGIPYmQJ.png) ```dart import 'package:getwidget/getwidget.dart'; @@ -52,9 +53,9 @@ GFAppBar( ### GF Flutter Appbar with SearchBar -![GF Flutter Appbar with SearchBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/with_search\_3x\_1A4y5PZuu.png) +![GF Flutter Appbar with SearchBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/with_search_3x_1A4y5PZuu.png) -**GFAppbar** has a parameter called`searchBar`wherein it is a boolean variable. If the searchBar is given the value`true`then it displays a search bar textfield in the title space of the appbar with **leading**, **trailing** options. +**GFAppbar** has a parameter called`searchBar`wherein it is a boolean variable. If the searchBar is given the value`true`then it displays a search bar textfield in the title space of the appbar with **leading**, **trailing** options. The below example demo code shows the example of how to pass the parameter. @@ -87,9 +88,9 @@ GFAppBar( ### GF Flutter custom Appbar with Segmented Tabs -![GF Flutter Appbar with Segmented Tabs](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Segmented\_3x_yGAKyoSOD.png) +![GF Flutter Appbar with Segmented Tabs](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Segmented_3x_yGAKyoSOD.png) -**Segmented** **tabs** can also be used inside the **GFAppbar**. In the **title** field of the Appbar just define the Segmented tab code and the work will be done. +**Segmented** **tabs** can also be used inside the **GFAppbar**. In the **title** field of the Appbar just define the Segmented tab code and the work will be done. The example below code shows a simple segmented tab inside Appbar. @@ -155,41 +156,161 @@ TabController tabController; The look and feel of the **GFAppbar search bar** can be customized using the GFAppbar properties. -| Name | Description | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **searchBar** | If true, displays search bar in the title space | -| **searchHintText** | It takes the text to displays the search bar hint text | -| **searchHintStyle** | It styles the \[searchHintText] | -| **searchTextStyle** | It styles the search text | -| **searchBarColorTheme** | It defines the search bar icons color theme | -| **searchController** | Controls the text being edited. If null, this widget will create its own \[TextEditingController] | -| **onChanged** | Called when the user initiates a change to the TextField's value: when they have inserted or deleted text | -| **onSubmitted** | Called when the user indicates that they are done editing the text in the field. | -| **onTap** | Called for each distinct tap except for every second tap of a double tap. If the text field is created with enabled false, taps will not be recognized. | +| Name | Description | +| :--- | :--- | +| **searchBar** | If true, displays search bar in the title space | +| **searchHintText** | It takes the text to displays the search bar hint text | +| **searchHintStyle** | It styles the \[searchHintText\] | +| **searchTextStyle** | It styles the search text | +| **searchBarColorTheme** | It defines the search bar icons color theme | +| **searchController** | Controls the text being edited. If null, this widget will create its own \[TextEditingController\] | +| **onChanged** | Called when the user initiates a change to the TextField's value: when they have inserted or deleted text | +| **onSubmitted** | Called when the user indicates that they are done editing the text in the field. | +| **onTap** | Called for each distinct tap except for every second tap of a double tap. If the text field is created with enabled false, taps will not be recognized. | ### **GF Flutter Appbar** Custom Properties Look and feel of the **GFAppbar** can be customized using the GFAppbar properties. -| Name | Description | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **leading** | A widget to display before the \[title] | -| **automaticallyImplyLeading** | Controls whether we should try to imply the leading widget if null. If true and \[leading] is null, automatically try to deduce what the leading widget should be. If false and \[leading] is null, leading space is given to \[title]. If leading widget is not null, this parameter has no effect. | -| **title** | The primary widget displayed in the app bar. Typically a \[Text] widget containing a description of the current contents of the app. | -| **actions** | Widgets to display after the \[title] widget. Typically these widgets are \[IconButton]s representing common operations. For less common operations, consider using a \[PopupMenuButton] as the last action. | -| **flexibleSpace** |

This widget is stacked behind the toolbar and the tab bar. It's height will

be the same as the app bar's overall height.

| -| **bottom** | This widget appears across the bottom of the app bar. Typically a \[TabBar]. Only widgets that implement \[PreferredSizeWidget] can be used at the bottom of an app bar. | -| **elevation** | The z-coordinate at which to place this app bar relative to its parent. This controls the size of the shadow below the app bar. The value is non-negative. | -| **shape** | The material's shape as well its shadow. A shadow is only displayed if the \[elevation] is greater than zero. | -| **backgroundColor** | The color to change background color of the app bar's material. | -| **brightness** | The brightness of the app bar's material. Typically this is set along with \[backgroundColor], \[iconTheme], \[textTheme]. | -| **iconTheme** | The color, opacity, and size to use for app bar icons. Typically this is set along with \[backgroundColor], \[brightness], \[textTheme]. | -| **actionsIconTheme** | The color, opacity, and size to use for the icons that appear in the appbar's \[actions]. This should only be used when the \[actions] should be themed differently than the icon that appears in the app bar's \[leading] widget. | -| **textTheme** | The typographic styles to use for text in the app bar. Typically this is set along with \[brightness] \[backgroundColor], \[iconTheme]. | -| **primary** | Whether this app bar is being displayed at the top of the screen. If true, the app bar's toolbar elements and \[bottom] widget will be padded on top by the height of the system status bar. The layout of the \[flexibleSpace] is not affected by the \[primary] property. | -| **centerTitle** | Whether the title should be centered. Defaults to being adapted to the current \[TargetPlatform]. | -| **titleSpacing** |

The spacing around [title] content on the horizontal axis. This spacing is applied even if there is no [leading] content or [actions]. If you want

[title] to take all the space available, set this value to 0.0.

| -| **toolbarOpacity** | How opaque the toolbar part of the app bar is. A value of 1.0 is fully opaque, and a value of 0.0 is fully transparent. | -| **bottomOpacity** | How opaque the bottom part of the app bar is. A value of 1.0 is fully opaque, and a value of 0.0 is fully transparent. | -| **preferredSize** | A size whose height is the sum of \[kToolbarHeight] and the \[bottom] widget's preferred height. \[Scaffold] uses this size to set its app bar's height. | -| **searchBar** | If true, displays search bar in the title space | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
leading + A widget to display before the [title]
automaticallyImplyLeading + Controls whether we should try to imply the leading widget if null. If + true and [leading] is null, automatically try to deduce what the leading + widget should be. If false and [leading] is null, leading space is given + to [title]. If leading widget is not null, this parameter has no effect.
title + The primary widget displayed in the app bar. Typically a [Text] widget + containing a description of the current contents of the app.
actions + Widgets to display after the [title] widget. Typically these widgets are + [IconButton]s representing common operations. For less common operations, + consider using a [PopupMenuButton] as the last action.
flexibleSpace + +

This widget is stacked behind the toolbar and the tab bar. It's height + will

+

be the same as the app bar's overall height.

+
bottom + This widget appears across the bottom of the app bar. Typically a [TabBar]. + Only widgets that implement [PreferredSizeWidget] can be used at the bottom + of an app bar.
elevation + The z-coordinate at which to place this app bar relative to its parent. + This controls the size of the shadow below the app bar. The value is non-negative.
shape + The material's shape as well its shadow. A shadow is only displayed + if the [elevation] is greater than zero.
backgroundColor + The color to change background color of the app bar's material.
brightness + The brightness of the app bar's material. Typically this is set along + with [backgroundColor], [iconTheme], [textTheme].
iconTheme + The color, opacity, and size to use for app bar icons. Typically this + is set along with [backgroundColor], [brightness], [textTheme].
actionsIconTheme + The color, opacity, and size to use for the icons that appear in the appbar's + [actions]. This should only be used when the [actions] should be themed + differently than the icon that appears in the app bar's [leading] + widget.
textTheme + The typographic styles to use for text in the app bar. Typically this + is set along with [brightness] [backgroundColor], [iconTheme].
primary + Whether this app bar is being displayed at the top of the screen. If true, + the app bar's toolbar elements and [bottom] widget will be padded + on top by the height of the system status bar. The layout of the [flexibleSpace] + is not affected by the [primary] property.
centerTitle + Whether the title should be centered. Defaults to being adapted to the + current [TargetPlatform].
titleSpacing + +

The spacing around [title] content on the horizontal axis. This spacing + is applied even if there is no [leading] content or [actions]. If you want

+

[title] to take all the space available, set this value to 0.0.

+
toolbarOpacity + How opaque the toolbar part of the app bar is. A value of 1.0 is fully + opaque, and a value of 0.0 is fully transparent.
bottomOpacity + How opaque the bottom part of the app bar is. A value of 1.0 is fully + opaque, and a value of 0.0 is fully transparent.
preferredSize + A size whose height is the sum of [kToolbarHeight] and the [bottom] widget's + preferred height. [Scaffold] uses this size to set its app bar's height.
searchBar + If true, displays search bar in the title space
+ diff --git a/src/gf-avatar.md b/src/gf-avatar.md index 505e4f8..74edda9 100644 --- a/src/gf-avatar.md +++ b/src/gf-avatar.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Avatar Widgets come with lots of custom properties like Square, Circle shape and also can use with Badge or other GF widgets. @@ -6,15 +7,15 @@ description: >- # GF Flutter Avatar -![Flutter Avatar Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Avatars\_1QfiwJn9kNW.png) +![Flutter Avatar Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Avatars_1QfiwJn9kNW.png) **GFAvatar** is a **Flutter Avatar** which is an image basically used to display the user picture in the profile section. **GFAvatar** has different shapes wherein the popular is a **Circular Avatar.** ## GF Flutter Circle Avatar -The **Flutter Circle Avatar widget** has a **circle shape** image**. GFAvatar** comes with different shapes, in which one of the default shapes is a **circle**. To place the image inside the **GFAvatar**, the image should be given in`backgroundImage`property. The below code shows a simple **Circle Avatar.** +The **Flutter Circle Avatar widget** has a **circle shape** image**. GFAvatar** comes with different shapes, in which one of the default shapes is a **circle**. To place the image inside the **GFAvatar**, the image should be given in`backgroundImage`property. The below code shows a simple **Circle Avatar.** -![Flutter Circle Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/circular-avatars-2x_YEAePfrqD\_-gE8M4y47.webp) +![Flutter Circle Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/circular-avatars-2x_YEAePfrqD_-gE8M4y47.webp) ```dart import 'package:getwidget/getwidget.dart'; @@ -39,7 +40,7 @@ GFAvatar( ) ``` -## GF Flutter Square Avatar +## GF Flutter Square Avatar **GFAvatar** has another type of avatar called **Square Avatar**. It is a Square shape avatar with no rounded corners as shown in the below image. The code below gives a Standard Avatar. @@ -58,14 +59,15 @@ GFAvatar( The look and feel of **GFAvatar** can be customized using the following properties: -| Name | Description | -| ------------------- | --------------------------------------------------------------------------------------------- | -| **child** | type of \[Widget], which can have text, icon, etc | -| **backgroundColor** | GFColor or Color to fill the background of the avatar | -| **foregroundColor** | GFColor or Color to change the textColor inside the avatar | -| **radius** | size of the avatar | -| **minRadius** | minimum size of the avatar | -| **maxRadius** | maximum size of the avatar | -| **size** | size of the avatar i.e `GFSize.large, GFSize.medium, GFSize.small` | -| **shape** | shape of the avatar i.e, `GFAvatarShape.standard, GFAvatarShape.circle, GFAvatarShape.square` | -| **borderRadius** | extra radius to avatar shapes, not applicable to the circular avatar | +| Name | Description | +| :--- | :--- | +| **child** | type of \[Widget\], which can have text, icon, etc | +| **backgroundColor** | GFColor or Color to fill the background of the avatar | +| **foregroundColor** | GFColor or Color to change the textColor inside the avatar | +| **radius** | size of the avatar | +| **minRadius** | minimum size of the avatar | +| **maxRadius** | maximum size of the avatar | +| **size** | size of the avatar i.e `GFSize.large, GFSize.medium, GFSize.small` | +| **shape** | shape of the avatar i.e, `GFAvatarShape.standard, GFAvatarShape.circle, GFAvatarShape.square` | +| **borderRadius** | extra radius to avatar shapes, not applicable to the circular avatar | + diff --git a/src/gf-badge.md b/src/gf-badge.md index 0bacce2..19d87f7 100644 --- a/src/gf-badge.md +++ b/src/gf-badge.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- Flutter Badge is a notification alarm that gives some additional information about the widget. @@ -8,7 +9,7 @@ description: >- ![GF Flutter Badges Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Badges_v0v7rCbeO.png) -## GF Flutter Badges +### GF Flutter Badges **GFBadges** are the **Flutter Badges** that are used to alert notification in the active widget. It gives the number of active notifications that arose. @@ -23,7 +24,7 @@ GFBadge( ), ``` -## GF Flutter Badge Size +### GF Flutter Badge Size **GFBadge** size can be varied using the **size** property, which specifies the size of the badge. Default badge size set to `GFSize.medium`. @@ -37,7 +38,7 @@ GFBadge( ), ``` -## GF Flutter Badge Shape +### GF Flutter Badge Shape the Shape of **GFBadge** can be changed by setting property **shape** to `GFIconButtonShape.circle`. Default shape of the Badge set to`GFIconButtonShape.standard`which gives square-shaped IconButton with slightly rounded corners. @@ -51,25 +52,25 @@ GFBadge( ), ``` -| Name | Description | -| --------------- | ------------------------------------------------------------------------------------- | -| **Description** | The GFBadge Shape | -| **Attribute** | shape | -| **Type** | `GFBadgeShape.standard, GFBadgeShape.square, GFBadgeShape.pills, GFBadgeShape.circle` | -| **Default** | `GFButtonShape.standard` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFBadge Shape | +| **Attribute** | shape | +| **Type** | `GFBadgeShape.standard, GFBadgeShape.square, GFBadgeShape.pills, GFBadgeShape.circle` | +| **Default** | `GFButtonShape.standard` | -## GF Flutter Badge Custom Properties +### GF Flutter Badge Custom Properties -| Name | Description | -| --------------- | ------------------------------------------------------- | -| **child** | child of type \[widget] alternative to text | -| **textcolor** | the color to use for this badge;s text | -| **textStyle** | defines the styling of the text | -| **border** | defines the border side | -| **bordershape** | defines the shape of the border | -| **color** | GFColor is used to change the background of the button. | +| Name | Description | +| :--- | :--- | +| **child** | child of type \[widget\] alternative to text | +| **textcolor** | the color to use for this badge;s text | +| **textStyle** | defines the styling of the text | +| **border** | defines the border side | +| **bordershape** | defines the shape of the border | +| **color** | GFColor is used to change the background of the button. | -## How to add badges in flutter button? +### How to add badges in flutter button? **GFBadges** can be used with buttons to display the number of notifications the active widget has. Below is the code for the button with GFBadge. @@ -87,9 +88,9 @@ GFButtonBadge( Default button **shape** set to`GFButtonShape.standard`so that we will get standard-shaped button with solid background color and slightly rounded corners. -## Flutter Solid Button Badge +### Flutter Solid Button Badge -![Flutter Solid Button Badge](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid-badge-buttons-2x_AEtC9rqrH\_9WGUj7cmx.png) +![Flutter Solid Button Badge](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid-badge-buttons-2x_AEtC9rqrH_9WGUj7cmx.png) By default, button **type** is set to`GFType.solid`so, we will get buttons that have a solid background color with slightly rounded corners. @@ -107,7 +108,7 @@ GFButtonBadge( ), ``` -## Flutter Disabled Button Badge +### Flutter Disabled Button Badge ![Flutter Disabled Button Badge](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/disabled-badge-buttons-2x_pRTAZyWWe_DdAbyhxxOt.png) @@ -125,9 +126,9 @@ GFButtonBadge( ), ``` -## Flutter Outline Button Badge +### Flutter Outline Button Badge -![Flutter Outline Button Badge ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-badge-buttons-2x-1\_-Tow_mzA3\_uCCZDyDrN.png) +![Flutter Outline Button Badge ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-badge-buttons-2x-1_-Tow_mzA3_uCCZDyDrN.png) **Flutter Outline Button** describes the button with a transparent background and a visible border. This button can be easily found in GFButton by adding **type** as **`GFType.outline`**. @@ -144,7 +145,7 @@ GFButtonBadge( ), ``` -## Flutter Pills Button Badge +### Flutter Pills Button Badge **Flutter Pills Badge** can be achieved by adding property **shape** as `GFButtonShape.pills`. @@ -161,7 +162,7 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## Flutter Button Badge Size +### Flutter Button Badge Size **GFButton size** can be varied using **size** property, which specifies the size of the button. Default button size set to `GFSize.medium`. @@ -178,91 +179,91 @@ GFButtonBadge( ), ``` -## GF Badge Custom Properties +### GF Badge Custom Properties **GF Button Badge** can be styled with several attributes to look a specific way. Each and every attribute is described below. -## How to change flutter badge color? +### How to change flutter badge color? **GFColor** is used to change the background of the button. -| Name | Description | -| --------------- | ------------------------------------------------- | +| Name | Description | +| :--- | :--- | | **Description** | The color to use from application's color pallete | -| **Attribute** | color | -| **Type** | `GFColor` | -| **Default** | `GFColor.primary` | +| **Attribute** | color | +| **Type** | `GFColor` | +| **Default** | `GFColor.primary` | -## How to change badge size in flutter? +### How to change badge size in flutter? **GFSize** property is used to change the size of **GFBadge** -| Name | Description | -| --------------- | -------------------------------------------- | -| **Description** | The GFButtonBadge Size | -| **Attribute** | size | -| **Type** | `GFSize.large, GFSize.medium, GfSize.small` | -| **Default** | `GFSize.medium` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFButtonBadge Size | +| **Attribute** | size | +| **Type** | `GFSize.large, GFSize.medium, GfSize.small` | +| **Default** | `GFSize.medium` | -## How to change Flutter badge shape? +### How to change Flutter badge shape? **GFBadge** shape can be changed using the **shape** parameter as shown below -| Name | Description | -| --------------- | ------------------------------------------------------------------- | -| **Description** | The GFButtonBadge Shape | -| **Attribute** | shape | -| **Type** | `GFButtonShape.standard, GFButtonShape.square, GFButtonShape.pills` | -| **Default** | `GFButtonShape.standard` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFButtonBadge Shape | +| **Attribute** | shape | +| **Type** | `GFButtonShape.standard, GFButtonShape.square, GFButtonShape.pills` | +| **Default** | `GFButtonShape.standard` | -## How to change Flutter Badges Type ? +### How to change Flutter Badges Type ? **GFBadge** type can be changed using the **type** parameter as shown below -| Name | Description | -| --------------- | -------------------------------------------------------------------- | -| **Description** | The GFButtonBadge Type | -| **Attribute** | type | -| **Type** | `GFType.solid, GFType.outline, GFType.outline2x, GFType.transparent` | -| **Default** | `GFType.solid` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFButtonBadge Type | +| **Attribute** | type | +| **Type** | `GFType.solid, GFType.outline, GFType.outline2x, GFType.transparent` | +| **Default** | `GFType.solid` | -## How to chnage Flutter Badge custom position ? +### How to chnage Flutter Badge custom position ? **GFBadge** position can be changed using the **position** parameter as shown below -| Name | Description | -| --------------- | ---------------------------------- | -| **Description** | The GFButtonBadge Position | -| **Attribute** | position | -| **Type** | `GFPosition.start, GFPosition.end` | -| **Default** | `GFPosition.start` | - -## GF Badge custom Properties - -| Name | Description | -| --------------------- | ----------------------------------------------------------------------------------- | -| **onPressed** | callback i.e, called when the button is tapped | -| **onLongPressed** | callback i.e, called when the button is long-pressed | -| **text** | text of type \[string] to describe button's label. text will be priority over child | -| **icon** | icon of type \[widget] to describe button's label with icon | -| **child** | child of type \[widget] alternative to text | -| **textcolor** | the color to use for this button's text when the button is enabled | -| **textStyle** | defines the styling of the text | -| **disabledColor** | the fillcolor of the button when the button is disabled | -| **disabledTextColor** | the color to use for this button's text when the button is disabled | -| **borderSide** | defines the border side | -| **bordershape** | defines the shape of the border | -| **buttonBoxShadow** | if `true,` default boxShadow appears around button. | -| **boxShadow** | defines the boxShadow | -| **fullWidthButton** | if `true,` defines the full width of the button. | -| **blockButton** | if `true`, defines the block button. | -| **padding** | defines internal padding of the button | -| **focusColor** | fillColor of the button when it has the input focused | -| **hoverColor** | fillColor of the button when the pointer is hovered over it | -| **splashColor** | indicates that the button has been touched | -| **highlightColor** | indicates that the button is actively being pressed | - -## Flutter Icon Badge Button +| Name | Description | +| :--- | :--- | +| **Description** | The GFButtonBadge Position | +| **Attribute** | position | +| **Type** | `GFPosition.start, GFPosition.end` | +| **Default** | `GFPosition.start` | + +### GF Badge custom Properties + +| Name | Description | +| :--- | :--- | +| **onPressed** | callback i.e, called when the button is tapped | +| **onLongPressed** | callback i.e, called when the button is long-pressed | +| **text** | text of type \[string\] to describe button's label. text will be priority over child | +| **icon** | icon of type \[widget\] to describe button's label with icon | +| **child** | child of type \[widget\] alternative to text | +| **textcolor** | the color to use for this button's text when the button is enabled | +| **textStyle** | defines the styling of the text | +| **disabledColor** | the fillcolor of the button when the button is disabled | +| **disabledTextColor** | the color to use for this button's text when the button is disabled | +| **borderSide** | defines the border side | +| **bordershape** | defines the shape of the border | +| **buttonBoxShadow** | if `true,` default boxShadow appears around button. | +| **boxShadow** | defines the boxShadow | +| **fullWidthButton** | if `true,` defines the full width of the button. | +| **blockButton** | if `true`, defines the block button. | +| **padding** | defines internal padding of the button | +| **focusColor** | fillColor of the button when it has the input focused | +| **hoverColor** | fillColor of the button when the pointer is hovered over it | +| **splashColor** | indicates that the button has been touched | +| **highlightColor** | indicates that the button is actively being pressed | + +### Flutter Icon Badge Button **GFBadges** can be used with Buttons to display the notifications with icons using **GFIconBadge** button as shown in the below example. @@ -282,7 +283,7 @@ GFIconBadge( Default icon button **shape is** set to `GFButtonShape.standard` so that we will able to get standard shaped button with solid background color with slightly rounded corners. -## Flutter Icon Button Badge Size +### Flutter Icon Button Badge Size **GFButton** size can be varied using **size** property, which specifies the size of the button. Default button size set to `GFSize.medium`. @@ -301,7 +302,7 @@ GFIconBadge( ), ``` -## Flutter Icon Button Badge Type +### Flutter Icon Button Badge Type **GFButton** type can be changed using property **type** by setting to `GFType.outline`. Default type of the IconButton will be `GFType.solid`. @@ -320,7 +321,7 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## Flutter Icon Button Badge Shape +### Flutter Icon Button Badge Shape The Shape of **Icon Button** can be changed by setting property **shape** to `GFIconButtonShape.circle`. Default shape of the IconButton set to `GFIconButtonShape.standard` which gives square shaped IconButton with slightly rounded corners. @@ -339,23 +340,24 @@ GFIconBadge( ), ``` -| Name | Description | -| --------------- | --------------------------------------------------------------------------------------------------------- | -| **Description** | The GFIconButton Shape | -| **Attribute** | shape | -| **Type** | `GFIconButtonShape.standard, GFIconButtonShape.square, GFIconButtonShape.pills, GFIconButtonShape.circle` | -| **Default** | `GFIconButtonShape.standard` | - -## Flutter Icon Button Custom Properties - -| Name | Description | -| ------------------- | ------------------------------------------------------- | -| **child** | child of type \[widget] alternative to text | -| **textcolor** | the color to use for this badge;s text | -| **textStyle** | defines the styling of the text | -| **borderSide** | defines the border side | -| **bordershape** | defines the shape of the border | -| **color** | GFColor is used to change the background of the button. | -| **iconSize** | defines the size of icon | -| **buttonBoxShadow** | if `true,` default boxShadow appears around button. | -| **boxShadow** | defines the boxShadow | +| Name | Description | +| :--- | :--- | +| **Description** | The GFIconButton Shape | +| **Attribute** | shape | +| **Type** | `GFIconButtonShape.standard, GFIconButtonShape.square, GFIconButtonShape.pills, GFIconButtonShape.circle` | +| **Default** | `GFIconButtonShape.standard` | + +### Flutter Icon Button Custom Properties + +| Name | Description | +| :--- | :--- | +| **child** | child of type \[widget\] alternative to text | +| **textcolor** | the color to use for this badge;s text | +| **textStyle** | defines the styling of the text | +| **borderSide** | defines the border side | +| **bordershape** | defines the shape of the border | +| **color** | GFColor is used to change the background of the button. | +| **iconSize** | defines the size of icon | +| **buttonBoxShadow** | if `true,` default boxShadow appears around button. | +| **boxShadow** | defines the boxShadow | + diff --git a/src/gf-border.md b/src/gf-border.md index 0910bde..f99aed6 100644 --- a/src/gf-border.md +++ b/src/gf-border.md @@ -6,7 +6,7 @@ description: >- # GF Flutter Border -**GF Flutter Border** is a Flutter Border that has all four sides and it makes a thin line around any widget. +**GF Flutter Border** is a Flutter Border that has all four sides and it makes a thin line around any widget. ![GF Flutter Border](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/GW-Borders_docs_banner_JIomXoiPKpc.png) @@ -14,11 +14,11 @@ description: >- ### GF Flutter Solid Border -**GFSolid Border** is a solid line and a basic border used for the many components. **GFBorder** property `[dashedLine`] takes an array of doubles like`[2, 0]` to display a solid border. +**GFSolid Border** is a solid line and a basic border used for the many components. **GFBorder** property `[dashedLine`\] takes an array of doubles like`[2, 0]` to display a solid border. The below example code shows a basic **Flutter solid border**. -![GF Flutter Solid Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid_border\_3x_yCU-0SBxv.png) +![GF Flutter Solid Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid_border_3x_yCU-0SBxv.png) ```dart Container( @@ -39,11 +39,11 @@ Container( ### GF Flutter Dashed Border -**GFDashed Border** is a customized border with dashed patterns used in UI designs. **GFBorder** property `[dashedLine`] takes an array of doubles`[4, 6]`to display a dashed border. +**GFDashed Border** is a customized border with dashed patterns used in UI designs. **GFBorder** property `[dashedLine`\] takes an array of doubles`[4, 6]`to display a dashed border. -The below example code shows a **dashed border in Flutter** +The below example code shows a **dashed border in Flutter** -![GF Flutter Dash Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/dashed_border\_3x_DQyNt2Emrew.png) +![GF Flutter Dash Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/dashed_border_3x_DQyNt2Emrew.png) ```dart Container( @@ -64,11 +64,11 @@ Container( ### GF Flutter Dotted Border -**GFDotted Border** is a customized border with dotted patterns used in many UI designs. **GFBorder** property `[dashedLine`] takes an array of doubles`[2, 1]`to display dotted border. +**GFDotted Border** is a customized border with dotted patterns used in many UI designs. **GFBorder** property `[dashedLine`\] takes an array of doubles`[2, 1]`to display dotted border. The below example code gives a dotted border around the image as shown below -![GF Flutter Dot Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Dotted_border\_3x_bVhWMc5Nv.png) +![GF Flutter Dot Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Dotted_border_3x_bVhWMc5Nv.png) ```dart Container( @@ -97,7 +97,7 @@ Container( **GFBorder** property `type` takes `GFBorderType.rect` to display borders with **no rounded corners** as shown in the below image. -![GF Flutter Rectange Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid_border_vw\_8B7kiHo.png) +![GF Flutter Rectange Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid_border_vw_8B7kiHo.png) ```dart Container( @@ -117,11 +117,11 @@ Container( ### GFBorderType.rRect -**GFBorder** has a property similar to the rectangle border but here the difference is that we will have rounded corners to the borders. +**GFBorder** has a property similar to the rectangle border but here the difference is that we will have rounded corners to the borders. -**GFBorder** property `type` takes `GFBorderType.rRect` to display borders with rounded corners. The below image shows rounded corners with the **rRect** property and the code is also given below +**GFBorder** property `type` takes `GFBorderType.rRect` to display borders with rounded corners. The below image shows rounded corners with the **rRect** property and the code is also given below -![GF Flutter Ractange dot Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/dashed_border_with_radius\_4NgBID_ne.png) +![GF Flutter Ractange dot Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/dashed_border_with_radius_4NgBID_ne.png) ```dart Container( @@ -146,7 +146,7 @@ Container( **GFBorder** property `type` takes `GFBorderType.oval` to display oval shape borders. -![GF Flutter Oval Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/circular_border\_-\_oval-solid\_3x_o_S1GuEvf.png) +![GF Flutter Oval Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/circular_border_-_oval-solid_3x_o_S1GuEvf.png) ```dart Container( @@ -168,7 +168,7 @@ Container( **GFBorder** property `type` takes `GFBorderType.circle` to display circular shape borders. -![GF Flutter Circle Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Dashed_border\_-\_circle\_3x_hoEZqNy-tw.png) +![GF Flutter Circle Border Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Dashed_border_-_circle_3x_hoEZqNy-tw.png) ```dart Container( @@ -192,12 +192,15 @@ Container( The look and feel of the **GFBorder** can be customized using the **GFBorder** properties. -| Name | Description | -| --------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| **child** | child of type \[Widget] which can be any component or text, etc | -| **padding** | padding for \[child] where in padding is given to the border types | -| **strokeWidth** | storkeWidth of type \[double] which is used to define the thickness of the border | -| **color** | color of type \[Color] or GFColor which is used to change the color of the border type | -| **dashedLine** | dashedLine of type \[List\] which is used for the linear and simple dashed line of border | -| **type** | type of \[GFBorderType] which is used to define the different types of borders ie, circle, Rect, RRect and oval | -| **radius** | radius of type \[Radius] used to give a curved border only when the border type is RRect, in other cases radius will not work | +| Name | Description | +| :--- | :--- | +| **child** | child of type \[Widget\] which can be any component or text, etc | +| **padding** | padding for \[child\] where in padding is given to the border types | +| **strokeWidth** | storkeWidth of type \[double\] which is used to define the thickness of the border | +| **color** | color of type \[Color\] or GFColor which is used to change the color of the border type | +| **dashedLine** | dashedLine of type \[List<double>\] which is used for the linear and simple dashed line of border | +| **type** | type of \[GFBorderType\] which is used to define the different types of borders ie, circle, Rect, RRect and oval | +| **radius** | radius of type \[Radius\] used to give a curved border only when the border type is RRect, in other cases radius will not work | + + + diff --git a/src/gf-bottomsheet.md b/src/gf-bottomsheet.md index d649e99..85c3a4f 100644 --- a/src/gf-bottomsheet.md +++ b/src/gf-bottomsheet.md @@ -8,11 +8,11 @@ description: >- **GFBottomSheet** is a **Flutter BottomSheet Model** that slides from the bottom of the screen and which prevents the user from using the other functionality of the app. It is just like a modal or popup that requires fewer actions from the user. -## GF Flutter Basic BottomSheet Model +### GF Flutter Basic BottomSheet Model -The basic **GFBottomSheet** Model code example is given below +The basic **GFBottomSheet** Model code example is given below -![](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Bottom_sheets_WIthout_overlay\_3x\_54GLWUK4I.png) +![](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Bottom_sheets_WIthout_overlay_3x_54GLWUK4I.png) ```dart final GFBottomSheetController _controller = GFBottomSheetController(); @@ -83,9 +83,9 @@ Scaffold( ) ``` -## GF Flutter Bottomsheet Model with Expandable content +### GF Flutter Bottomsheet Model with Expandable content -**GFBottomSheet** allows the user to expand the content body to display more content. The property `enableExpandableContent` on `true` makes the content body expandable. The blow code shows how to expand the content bypassing the boolean value. +**GFBottomSheet** allows the user to expand the content body to display more content. The property `enableExpandableContent` on `true` makes the content body expandable. The blow code shows how to expand the content bypassing the boolean value. ```dart final GFBottomSheetController _controller = GFBottomSheetController(); @@ -172,20 +172,99 @@ GFBottomSheet( ), ``` -## **GF Flutter Bottomsheet Model** Custom Properties +### **GF Flutter Bottomsheet Model** Custom Properties The look and feel of the **GFBottomsheet** can be customized using the GFBottomsheet properties. -| Name | Description | -| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **minContentHeight** |

[minContentHeight] controls the minimum height of the content body.

Content body with [minContentHeight] displays only when [enableExpandableContent] is false.

It Must be greater or equal to 0. Default value is 0.

| -| **maxContentHeight** |

[maxContentHeight] controls the maximum height of the content body.

It Must be greater or equal to 0. Default value is 300.

| -| **stickyHeader** |

[stickyHeader] is the header of GFBottomSheet.

User can interact by swiping or tapping the [stickyHeader]

| -| **contentBody** |

[contentBody] is the body of GFBottomSheet.

User can interact by swiping or tapping the [contentBody]

| -| **stickyFooter** |

[stickyFooter] is the footer of GFBottomSheet.

User can interact by swiping or tapping the [stickyFooter]

| -| **stickyFooterHeight** | \[stickyFooterHeight] defines the height of GFBottomSheet's \[stickyFooter] | -| **stickyHeaderHeight** | \[stickyHeaderHeight] defines the height of GFBottomSheet's \[stickyHeader] | -| **elevation** |

[elevation] controls shadow below the GFBottomSheet material.

Must be greater or equal to 0. Default value is 0.

| -| **enableExpandableContent** |

[enableExpandableContent] allows [contentBody] to expand.

Default value is false.

| -| **controller** | \[controller] used to control GFBottomSheet behavior like hide/show | -| **animationDuration** |

Defines the drag animation duration of the GFBottomSheet

Default value is 300.

| + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
minContentHeight + +

[minContentHeight] controls the minimum height of the content body.

+

Content body with [minContentHeight] displays only when [enableExpandableContent] + is false.

+

It Must be greater or equal to 0. Default value is 0.

+
maxContentHeight + +

[maxContentHeight] controls the maximum height of the content body.

+

It Must be greater or equal to 0. Default value is 300.

+
stickyHeader + +

[stickyHeader] is the header of GFBottomSheet.

+

User can interact by swiping or tapping the [stickyHeader]

+
contentBody + +

[contentBody] is the body of GFBottomSheet.

+

User can interact by swiping or tapping the [contentBody]

+
stickyFooter + +

[stickyFooter] is the footer of GFBottomSheet.

+

User can interact by swiping or tapping the [stickyFooter]

+
stickyFooterHeight + [stickyFooterHeight] defines the height of GFBottomSheet's [stickyFooter]
stickyHeaderHeight + [stickyHeaderHeight] defines the height of GFBottomSheet's [stickyHeader]
elevation + +

[elevation] controls shadow below the GFBottomSheet material.

+

Must be greater or equal to 0. Default value is 0.

+
enableExpandableContent + +

[enableExpandableContent] allows [contentBody] to expand.

+

Default value is false.

+
controller + [controller] used to control GFBottomSheet behavior like hide/show
animationDuration + +

Defines the drag animation duration of the GFBottomSheet

+

Default value is 300.

+
+ diff --git a/src/gf-button/.DS_Store b/src/gf-button/.DS_Store new file mode 100644 index 0000000..bee5fb3 Binary files /dev/null and b/src/gf-button/.DS_Store differ diff --git a/src/gf-button/README.md b/src/gf-button/README.md index 7333be5..8370d59 100644 --- a/src/gf-button/README.md +++ b/src/gf-button/README.md @@ -1,8 +1,12 @@ --- +sidebarDepth: 2 description: >- - How to design a custom flutter button with GF Button with the option to create - disable button, Square button, Social button, Elevated button, icon button - with 100+ properties to customize. + GF Button is Flutter Button Widgets that come with a 100+ pre-built button + with endless color combinations that you can use straightway in your project. +image: >- + https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Gw_buttons_E5z1JheN4.png +canonicalUrl: https://docs.getwidget.dev/gf-button + --- # Flutter Button Widget @@ -11,9 +15,9 @@ description: >- **GF Button** is a **Flutter Button** that is a clickable element, that can be used for click events like **click functions, page routing**, **social authentications**, **form submissions,** or anywhere that needs simple, standard button functionality. **Flutter Buttons** have a broad area and can be used with any other widgets as well. -## How to create GF Button in Flutter? +### How to create GF Button in Flutter? -The **Flutter Buttons** are the very simple yet most commonly used component in almost all of the pages. The simple code of a **GFButton** looks like the following: +The **Flutter Buttons** are the very simple yet most commonly used component in almost all of the pages. The simple code of a **GFButton** looks like the following: ```dart GFButton( @@ -22,7 +26,7 @@ GFButton( ), ``` -## Flutter Disabled Button +### Flutter Disabled Button The **Flutter Disable Button** is used to get a disabled button in the application. The disabled button will have a `null` value on the **onPressed** parameter. The simple code of the **GFDisabled Button** is as follows: @@ -33,116 +37,113 @@ GFButton( ), ``` -## GF Flutter Button Properties +### Flutter GF Button Properties **GF Buttons** or **Flutter Buttons** are a very widely used component in any application. Hence the **GFButtons** are highly customizable and have a wide range of properties that gives a better look and feel for any application. The **GFButton's properties** are described below: -## [FLUTTER ELEVATED BUTTON](https://docs.getwidget.dev/gf-button/standard-button/) - -**Flutter Elevated Button** is a **button in flutter** which is the most commonly used **flutter button** which upon clicking, elevates or triggers to show the button action. The more customized properties can be seen in Gf [Flutter Elevated Button](https://docs.getwidget.dev/gf-button/standard-button/) +### FLUTTER ELEVATED/STANDARD BUTTON -## [FLUTTER ROUNDED BUTTON](https://docs.getwidget.dev/gf-button/pills-button) +**Flutter Elevated Button** is a **button in flutter** which is the most commonly used **flutter button** which upon clicking, elevates or triggers to show the button action. The more customized properties can be seen in **GF Elevated Button** [**https://docs.getwidget.dev/gf-button/standard-button/**](https://docs.getwidget.dev/gf-button/standard-button/)\*\*\*\* -**Flutter Rounded Button** or **Flutter Pills Button** is a **button in flutter** wherein the corners of the buttons are circular in shape. In other words, it is a button with border-radius in it. For more customizable properties head to [**Flutter Pills/Rounded Button**](https://docs.getwidget.dev/gf-button/pills-button)**.** +### FLUTTER ROUNDED BUTTON -## [FLUTTER ICON BUTTON](https://docs.getwidget.dev/gf-button/icon-button/) +**Flutter Rounded Button** or **Flutter Pills Button** is a **button in flutter** wherein the corners of the buttons are circular in shape. In other words, it is a button with border-radius in it. For more customizable properties head to **Flutter Pills/Rounded Button** [https://docs.getwidget.dev/gf-button/pills-button/](https://docs.getwidget.dev/gf-button/pills-button/) -**Flutter Icon Button** or **Icon Button Flutter** is a **flutter button** where the button has icons on them. It can even have a **text** which is a **button with text** or **text with an** **icon** which is a **text icon button.** To know more about **Icon Button** head to the** **[**Flutter Icon Button**](https://docs.getwidget.dev/gf-button/icon-button/) section +### FLUTTER ICON BUTTON -## ****[**FLUTTER TOGGLE BUTTON**](../gf-toggle.md)**** +**Flutter Icon Button** or **Icon Button Flutter** is a **flutter button** where the button has icons on them. It can even have a **text** which is a **button with text** or **text with an** **icon** which is a **text icon button.** To know more about **Icon Button** head to **the Flutter Icon Button** section [https://docs.getwidget.dev/gf-button/icon-button/](https://docs.getwidget.dev/gf-button/icon-button/) -**Flutter Toggle Button** or **Flutter Toggle Switch** is a switch button **that toggles between two states and the two states are often **ON/OFF state. +### **FLUTTER TOGGLE BUTTON** -**For more information head to **[Flutter Toggle Switch Button.](https://docs.getwidget.dev/gf-toggle) +**Flutter Toggle Button** or **Flutter Toggle Switch** is ****a **switch button** that toggles between two states and the two states are often **ON/OFF** state**.** For more information head to **Flutter Toggle Switch Button** [**https://docs.getwidget.dev/gf-toggle/**](https://docs.getwidget.dev/gf-toggle/)**.** -## [FLUTTER CIRCULAR BUTTON](https://docs.getwidget.dev/gf-button/pills-button) +### FLUTTER CIRCULAR BUTTON -**Flutter circular button** or **Flutter Pills/Rounded Button** is a type of **Flutter Button** that has circular corners in them. For more examples head to [Flutter Circular button](https://docs.getwidget.dev/gf-button/pills-button) +**Flutter circular button** or **Flutter Pills/Rounded Button** is a type of **Flutter Button** that has circular corners in them. For more examples head to [https://docs.getwidget.dev/gf-button/pills-button/](https://docs.getwidget.dev/gf-button/pills-button/) -[FLUTTER BUTTON WIDGET MORE EXAMPLE CODE](https://www.getwidget.dev/blog/flutter-button-widget-component/) **: **You can follow our Blogs for more example demo code for the flutter button with GFButton. - -### How to Set Button Color in flutter? +#### How to Set Button Color in flutter? **Button** **Colors** can be the background fill colors for solid buttons or the color can be for the border to the outline buttons. **GFColors** are used to change the background of the button. -| Name | Description | -| --------------- | --------------------------------------------------- | +| Name | Description | +| :--- | :--- | | **Description** | The color to use from the application color palette | -| **Attribute** | color | -| **Type** | `GFColors` | -| **Default** | GFColors.PRIMARY | +| **Attribute** | color | +| **Type** | `GFColors` | +| **Default** | GFColors.PRIMARY | -### How to Set Button Size in Flutter? +#### How to Set Button Size in Flutter? **Flutter** **Button** can be of any size and can be changed according to the need. **GFSize** can be used to determine the size of the buttons as follows: -| Name | Description | -| --------------- | -------------------------------------------- | -| **Description** | The GFButton Size | -| **Attribute** | size | -| **Type** | `GFSize.LARGE, GFSize.MEDIUM, GFSize.SMALL` | -| **Default** | `GFSize.MEDIUM` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFButton Size | +| **Attribute** | size | +| **Type** | `GFSize.LARGE, GFSize.MEDIUM, GFSize.SMALL` | +| **Default** | `GFSize.MEDIUM` | -### How to Change Button Shape in Flutter? +#### How to Change Button Shape in Flutter? -The **shape of the button** like **standard**, **square**, or **pills** can be determined by the shape property. +The **shape of the button** like **standard**, **square**, or **pills** can be determined by the shape property. -| Name | Description | -| --------------- | ------------------------------------------------------------------- | -| **Description** | The GFButton Shape | -| **Attribute** | shape | -| **Type** | `GFButtonShape.standard, GFButtonShape.square, GFButtonShape.pills` | -| **Default** | `GFButtonShape.standard` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFButton Shape | +| **Attribute** | shape | +| **Type** | `GFButtonShape.standard, GFButtonShape.square, GFButtonShape.pills` | +| **Default** | `GFButtonShape.standard` | -## GF Flutter Button Type Properties +### GF Flutter Button Type Properties The **button type** of the button like **solid**, **outline** can be determined by the following properties: -| Name | Description | -| --------------- | -------------------------------------------------------------------------------------------- | -| **Description** | The GFButton Type | -| **Attribute** | type | -| **Type** | `GFButtonType.solid, GFButtonType.outline, GFButtonType.outline2x, GFButtonType.transparent` | -| **Default** | `GFButtonType.solid` | +| Name | Description | +| :--- | :--- | +| **Description** | The GFButton Type | +| **Attribute** | type | +| **Type** | `GFButtonType.solid, GFButtonType.outline, GFButtonType.outline2x, GFButtonType.transparent` | +| **Default** | `GFButtonType.solid` | -### How to change Button Position in Flutter? +#### How to change Button Position in Flutter? The **GFButton** can be placed in the `start` or at the `end` of the **position** using the position property: -| Name | Description | -| --------------- | ---------------------------------- | -| **Description** | Position of icon in the button. | -| **Attribute** | position | -| **Type** | `GFPosition.start, GFPosition.end` | -| **Default** | `GFPosition.start` | - -## GFButton Custom Properties - -**Flutter Buttons** can be customized using **GFButton** Custom properties which are listed below: - -| Name | Description | -| --------------------- | ------------------------------------------------------------------- | -| **onPressed** | callback i.e, called when the button is tapped | -| **onLongPressed** | callback i.e, called when the button is long-pressed | -| **text** | describe the button's label. text will be a priority over child | -| **icon** | describe button's label with icon | -| **child** | child of type Widget alternative to text | -| **textColor** | the color to use for this button's text when the button is enabled | -| **textStyle** | defines the styling of the text | -| **disabledColor** | the fillcolor of the button when the button is disabled | +| Name | Description | +| :--- | :--- | +| **Description** | Position of icon in the button. | +| **Attribute** | position | +| **Type** | `GFPosition.start, GFPosition.end` | +| **Default** | `GFPosition.start` | + +### GFButton Custom Properties + +**Flutter Buttons** can be customised using **GFButton** Custom properties which are listed below: + +| Name | Description | +| :--- | :--- | +| **onPressed** | callback i.e, called when the button is tapped | +| **onLongPressed** | callback i.e, called when the button is long-pressed | +| **text** | describe the button's label. text will be a priority over child | +| **icon** | describe button's label with icon | +| **child** | child of type Widget alternative to text | +| **textColor** | the color to use for this button's text when the button is enabled | +| **textStyle** | defines the styling of the text | +| **disabledColor** | the fillcolor of the button when the button is disabled | | **disabledTextColor** | the color to use for this button's text when the button is disabled | -| **borderSide** | defines the border side | -| **bordershape** | defines the shape of the border | -| **buttonBoxShadow** | if `true,` default boxShadow appears around the button. | -| **boxShadow** | defines the boxShadow | -| **fullWidthButton** | if `true,` defines the full width of the button. | -| **blockButton** | if `true`, defines the block button. | -| **padding** | defines internal padding of the button | -| **focusColor** | fillColor of the button when it has the input focused | -| **hoverColor** | fillColor of the button when the pointer is hovered over it | -| **splashColor** | indicates that the button has been touched | -| **highlightColor** | indicates that the button is actively being pressed | +| **borderSide** | defines the border side | +| **bordershape** | defines the shape of the border | +| **buttonBoxShadow** | if `true,` default boxShadow appears around the button. | +| **boxShadow** | defines the boxShadow | +| **fullWidthButton** | if `true,` defines the full width of the button. | +| **blockButton** | if `true`, defines the block button. | +| **padding** | defines internal padding of the button | +| **focusColor** | fillColor of the button when it has the input focused | +| **hoverColor** | fillColor of the button when the pointer is hovered over it | +| **splashColor** | indicates that the button has been touched | +| **highlightColor** | indicates that the button is actively being pressed | + diff --git a/src/gf-button/icon-button.md b/src/gf-button/icon-button.md index 56090c1..f1f71dc 100644 --- a/src/gf-button/icon-button.md +++ b/src/gf-button/icon-button.md @@ -1,18 +1,23 @@ --- +sidebarDepth: 2 description: >- Flutter Icon button is a button that has a icon with solid background fill color in it. +image: >- + https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Icon_buttons_inVOVWej_.png +canonicalUrl: https://docs.getwidget.dev/gf-button/icon-button/ + --- # Flutter Icon Button -![GF Flutter Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Icon_buttons_inVOVWej\_.png) +![GF Flutter Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Icon_buttons_inVOVWej_.png) ## Flutter Icon Button -**Flutter Icon Button** or **Icon Button Flutter** is a flutter button where the button has icons on them. +**Flutter Icon Button** or **Icon Button Flutter** is a flutter button where the button has icons on them. -**GFIcon Button** is an **Icon Flutter Button** that can have an icon, text, and a combination of both icon and text on it. +**GFIcon Button** is an **Icon Flutter Button** that can have an icon, text, and a combination of both icon and text on it. **GFButtons** are clickable buttons that are used widely in an application. **GFButtons** come in many shapes and types. One of them is **Flutter Icon Button.** @@ -37,7 +42,7 @@ GFIconButton( ## Flutter Solid Icon Button -![Flutter Solid Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid-icon-button-2x_x7HdkO4Xa\_5i6iwtmoQY.png) +![Flutter Solid Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid-icon-button-2x_x7HdkO4Xa_5i6iwtmoQY.png) By default, button **type** is set to `GFButtonType.solid` so, we were able to get buttons that have a solid background color with slightly rounded corners. @@ -55,7 +60,7 @@ import 'package:getwidget/getwidget.dart'; ## Flutter Outline Icon Button -![Flutter Outline Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-icon-button-2x-1\_9DnBbeMtB_kkUSHBKTef.png) +![Flutter Outline Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-icon-button-2x-1_9DnBbeMtB_kkUSHBKTef.png) **The Flutter Outline Button** describes the button with a transparent background and a visible border. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline`**. @@ -72,7 +77,7 @@ GFButton( ## Flutter Outline2x Icon Button -![Flutter Outline2x Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-icon-button-2x_RwMGJ0MJ\_\_5VFGKu0tkD.png) +![Flutter Outline2x Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-icon-button-2x_RwMGJ0MJ__5VFGKu0tkD.png) The **Flutter Outline Icon Button** describes the button with a transparent background and a visible border of 2x border width. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline2x`**. @@ -106,7 +111,7 @@ GFButton( ![Flutter Pills Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-icon-button-2x_o-E933fNd_XL_kSsNAyvto.png) -We will be able to get **pills shaped** button with solid background color with rounded corners by adding property **shape** with **`GFButtonShape.pills`** . +We will be able to get **pills shaped** button with solid background color with rounded corners by adding property **shape** with **`GFButtonShape.pills`** . ```dart import 'package:getwidget/getwidget.dart'; @@ -138,7 +143,7 @@ import 'package:getwidget/getwidget.dart'; ## Flutter Block Icon Button -![Flutter Block Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/block-icon-button-2x_jb9rGWSR9\_Dm-XpRE3dgwQ.png) +![Flutter Block Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/block-icon-button-2x_jb9rGWSR9_Dm-XpRE3dgwQ.png) **The Flutter Block button** specifies how wide the button should be. By setting **blockButton** state, `true`it will change the button to a full-width block with rounded corners. Default **blockButton** set to `false`. @@ -156,9 +161,9 @@ GFButton( ## Flutter Full Width Icon Button -![Flutter Full Width Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/fullwidth-icon-button-2x-1\_rsx_EmmVZ_A_wcghxKaW.png) +![Flutter Full Width Icon Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/fullwidth-icon-button-2x-1_rsx_EmmVZ_A_wcghxKaW.png) -The **Flutter Full-Width** **button** specifies the button should be in full width of the screen. By setting a f**ullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right side. Default **fullWidthButton** set to `false`. +The **Flutter Full-Width** **button** specifies the button should be in full width of the screen. By setting a f**ullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right side. Default **fullWidthButton** set to `false`. ```dart import 'package:getwidget/getwidget.dart'; @@ -174,7 +179,7 @@ GFButton( ## Flutter Icon Button Size -**The Flutter Button size** can be varied using the **size** property, which specifies the size of the button. The Default button size is set to `GFSize.MEDIUM`. +**The Flutter Button size** can be varied using the **size** property, which specifies the size of the button. The Default button size is set to `GFSize.MEDIUM`. ```dart import 'package:getwidget/getwidget.dart'; @@ -216,7 +221,7 @@ GFIconButton( ), ``` -### Flutter GF Icon Button Type +### Flutter GF Icon Button Type **The Flutter Button type** can be changed by using property **type** and setting to`GFButtonType.outline`. The default type of the IconButton will be `GFType.solid`. @@ -244,23 +249,24 @@ GFIconButton( ), ``` -| | | -| --------------- | --------------------------------------------------------------------------------------------------------- | -| **Description** | The GFIconButton Shape | -| **Attribute** | shape | -| **Type** | `GFIconButtonShape.standard, GFIconButtonShape.square, GFIconButtonShape.pills, GFIconButtonShape.circle` | -| **Default** | `GFIconButtonShape.standard` | +| | | +| :--- | :--- | +| **Description** | The GFIconButton Shape | +| **Attribute** | shape | +| **Type** | `GFIconButtonShape.standard, GFIconButtonShape.square, GFIconButtonShape.pills, GFIconButtonShape.circle` | +| **Default** | `GFIconButtonShape.standard` | ### Flutter GF Button Custom Properties -| Name | Description | -| ------------------- | ------------------------------------------------------- | -| **child** | child of type \[widget] alternative to text | -| **textColor** | the color to use for this badge's text | -| **textStyle** | defines the styling of the text | -| **borderSide** | defines the border side | -| **borderShape** | defines the shape of the border | -| **color** | GFColor is used to change the background of the button. | -| **iconSize** | defines the size of an icon | +| Name | Description | +| :--- | :--- | +| **child** | child of type \[widget\] alternative to text | +| **textColor** | the color to use for this badge's text | +| **textStyle** | defines the styling of the text | +| **borderSide** | defines the border side | +| **borderShape** | defines the shape of the border | +| **color** | GFColor is used to change the background of the button. | +| **iconSize** | defines the size of an icon | | **buttonBoxShadow** | if `true,` default boxShadow appears around the button. | -| **boxShadow** | defines the boxShadow | +| **boxShadow** | defines the boxShadow | + diff --git a/src/gf-button/pills-button.md b/src/gf-button/pills-button.md index 78ef2df..ebd6424 100644 --- a/src/gf-button/pills-button.md +++ b/src/gf-button/pills-button.md @@ -1,17 +1,18 @@ --- +sidebarDepth: 2 description: >- Flutter Pills/Rounded/Circular Button Widget looks like a solid button with rounded corners. It comes with 200 + custom properties to customize button size, color. --- -# Flutter Pills Button +# Flutter Pills/Rounded Button -![Flutter Pills Button Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Pills_button-solid_VWUMopUjx\_.png) +![Flutter Pills Button Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Pills_button-solid_VWUMopUjx_.png) **GFButtons** are clickable buttons that are used widely in an application. **GFButtons** come in many shapes and one of the shapes is a **pill-shaped button.** -We will be able to get **flutter** **circular/rounded** shaped button with solid background color with rounded corners by adding property **shape** with `GFButtonShape.pills` +We will be able to get **flutter** **circular/rounded** shaped button with solid background color with rounded corners by adding property **shape** with `GFButtonShape.pills` The simple example of **GFButton with pill shape** is as follows: @@ -29,7 +30,7 @@ GFButton( ![Flutter Pills/Rounded Solid Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-solid-button-2x_EQT2X6jAl_BLgdXpw26c7E.png) -By default, button **type** is set to `GFButtonType.solid` so, that we will be able to get pills shaped buttons that have a solid background color with rounded corners. +By default, button **type** is set to `GFButtonType.solid` so, that we will be able to get pills shaped buttons that have a solid background color with rounded corners. The callback is called when the button is tapped. By adding a callback to **onPressed** enables the button. @@ -45,7 +46,7 @@ import 'package:getwidget/getwidget.dart'; ## Flutter Pills/Rounded Disabled Button -![Flutter Pills Disabled Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-disabled-2x_lVoPerI-o\_-pNn9kds88.png) +![Flutter Pills Disabled Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-disabled-2x_lVoPerI-o_-pNn9kds88.png) If this callback and **onPressed** are null, then the button will be disabled. Default GFButton will be disabled because **onPressed** set to null. @@ -78,7 +79,7 @@ GFButton( ## Flutter Pills/Rounded Full Width Button -![Flutter Full Width Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/full-width-2x_pKifhtU6P\_908jFrHjHx.png) +![Flutter Full Width Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/full-width-2x_pKifhtU6P_908jFrHjHx.png) The **Flutter Full-Width** **button** specifies the button should be in full width of the screen. By setting a **fullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right. Default **fullWidthButton** set to `false`. @@ -93,7 +94,7 @@ GFButton( ), ``` -## Flutter Rounded Button Size +## Flutter Rounded Button Size **Flutter Button size** can be varied using the **size** property, which specifies the size of the button. Default button size set to `GFSize.MEDIUM`. @@ -110,7 +111,7 @@ GFButton( ## Flutter Pills/Rounded Outline Button -![Flutter Pills Outline Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/pills-outline-2x_iq1SEFIpR_yeuxE-DmfT.png) +![Flutter Pills Outline Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs//pills-outline-2x_iq1SEFIpR_yeuxE-DmfT.png) **Flutter Pill Outline Button** describes as the Button with a transparent background and a visible border. This button can easily get in GFButton by adding **type** as **`GFButtonType.outline`**. @@ -125,13 +126,13 @@ GFButton( ), ``` -Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline Button** also. +Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline Button** also. ## Flutter Pills/Rounded Outline2x Button -![Flutter Pills Outline2x Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-outline-2x-2x_Qez5VXh02\_zOFwwDB3SRU.png) +![Flutter Pills Outline2x Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-outline-2x-2x_Qez5VXh02_zOFwwDB3SRU.png) -**Flutter Pills Outline2x Button** describes as the Button with a transparent background and a visible border with 2x border-width. This button can easily get in GFButton by adding **type** as **`GFButtonType.outline2x`**. +**Flutter Pills Outline2x Button** describes as the Button with a transparent background and a visible border with 2x border-width. This button can easily get in GFButton by adding **type** as **`GFButtonType.outline2x`**. ```dart import 'package:getwidget/getwidget.dart'; @@ -144,4 +145,5 @@ GFButton( ), ``` -Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline2x Button** also. +Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline2x Button** also. + diff --git a/src/gf-button/social-button.md b/src/gf-button/social-button.md index c26d1be..9d7d2c8 100644 --- a/src/gf-button/social-button.md +++ b/src/gf-button/social-button.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- Flutter Social Buttons are a set of buttons that are used to get sign-in buttons for any social media account, GF social button comes with lots of @@ -7,7 +8,7 @@ description: >- # Flutter Social Button -![Flutter Social Button UI Design ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Social_Buttons\_359dhW\_7Eo0.png) +![Flutter Social Button UI Design ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Social_Buttons_359dhW_7Eo0.png) ## Flutter Social Button @@ -23,7 +24,7 @@ The Default button **shape** is set`GFButtonShape.standard`so that we will be ab ![Flutter Solid Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/square-social-button-2x_ofI-wQHkM_kJIyYkwhYR.png) -The Below code gives the **icon with the text button** as the above image: The **icon parameter** can be any widget like **default flutter icons** or **customized asset images** or **icons**. Unless The icon parameter is not passed, we will get a default GFButton without the icon +The Below code gives the **icon with the text button** as the above image: The **icon parameter** can be any widget like **default flutter icons** or **customized asset images** or **icons**. Unless The icon parameter is not passed, we will get a default GFButton without the icon ```dart import 'package:getwidget/getwidget.dart'; @@ -37,7 +38,7 @@ The Below code gives the **icon with the text button** as the above image: The * ## Flutter Disabled Social Button with Text -![Flutter Disabled Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/disabled-buttons-2x-1\_WXYljNGX9\_Og84OQ7\_j.png) +![Flutter Disabled Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/disabled-buttons-2x-1_WXYljNGX9_Og84OQ7_j.png) If this callback and **onPressed** are null, then the button will be disabled. Default **GFButton** will be disabled as **onPressed** is set to null. @@ -53,7 +54,7 @@ GFButton( ## Flutter Outline Social Button with Text -![Outline Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-social-button-2x-1\_s9l5xQdik\_18Ar4Rbfp0Z.png) +![Outline Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-social-button-2x-1_s9l5xQdik_18Ar4Rbfp0Z.png) **The Flutter Outline Button** describes the Button with a transparent background and a visible border. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline`**. @@ -70,7 +71,7 @@ GFButton( ## Flutter Outline2x Social Button with Text -![Flutter Outline2x Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-social-button-2x\_3hSCzrQDG_YjwynP9h8q.png) +![Flutter Outline2x Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-social-button-2x_3hSCzrQDG_YjwynP9h8q.png) **The Flutter Outline** **Icon** Button describes the Button with a transparent background and a visible border of 2x border width. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline2x`**. @@ -104,7 +105,7 @@ GFButton( ## Flutter Circular/Rounded Social Button with Text -![Flutter Pills Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-social-buttons-2x_GfJjVk77h_itBRIApxau.png) +![Flutter Pills Social Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/pills-social-buttons-2x_GfJjVk77h_itBRIApxau.png) We will be able to get the **circular or rounded** **shaped** **buttons** with solid background color with rounded corners by adding property **shape** with `GFButtonShape.pills` . @@ -138,7 +139,7 @@ We will be able to get a **square-shaped button** with solid background color wi ## Flutter Social Button Size Properties -![Flutter Facebook Social Button Size](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/full-width-social-button-2x-1\_45MJ57qDeo_LWX7K-eIj9.png) +![Flutter Facebook Social Button Size](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/full-width-social-button-2x-1_45MJ57qDeo_LWX7K-eIj9.png) The **Flutter Social Button size** can be varied using the **size** property, which specifies the size of the button. Default button size is set to `GFSize.MEDIUM`. @@ -155,7 +156,7 @@ GFButton( ## Flutter Block Social Button -![Flutter Social Button ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/block-social-button-2x_rkTw_Ij63\_tp2AOfDiWy.png) +![Flutter Social Button ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/block-social-button-2x_rkTw_Ij63_tp2AOfDiWy.png) **The Flutter Block button** specifies how wide the button should be with some spacing on both the left and right sides. By setting **blockButton** state, `true` it will change the button to a full-width block. Default **blockButton** is set to `false`. @@ -173,7 +174,7 @@ GFButton( ## Flutter Full Width Social Button -![Flutter Full Width Social Button](https://ik.imagekit.io/ionicfirebaseapp/docs/full-width-social-button-2x-1\_45MJ57qDeo_LWX7K-eIj9.png) +![Flutter Full Width Social Button](https://ik.imagekit.io/ionicfirebaseapp/docs/full-width-social-button-2x-1_45MJ57qDeo_LWX7K-eIj9.png) The **Flutter Full-Width** **button** specifies the button should be in full width of the screen. By setting a f**ullWidthButton** state,`true` it will change the button to a Full-width button. Default **fullWidthButton** set to `false`. @@ -249,3 +250,4 @@ GFIconButton( shape: GFIconButtonShape.pills, ), ``` + diff --git a/src/gf-button/square-button.md b/src/gf-button/square-button.md index 018adf2..d0af818 100644 --- a/src/gf-button/square-button.md +++ b/src/gf-button/square-button.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Square Button Widget looks like a solid button without rounded corners. It comes with 100 + custom properties to customize button size, @@ -59,7 +60,7 @@ GFButton( ## Flutter Square Block Button -![Flutter Square Block Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/block-2x_zhfeGvIuT0\_wkwKmGk-Z.png) +![Flutter Square Block Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/block-2x_zhfeGvIuT0_wkwKmGk-Z.png) **The Flutter Block button** specifies how wide the button should be. By setting **blockButton** state,`true` it will change the button to a full-width block with no rounded corners. Default **blockButton** is set to `false`. @@ -76,9 +77,9 @@ GFButton( ## Flutter Square Full-Width Button -![Flutter Square Full Width Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/fullwidth-2x_R1MRr5rgb\_8s0AW1X_soKM.png) +![Flutter Square Full Width Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/fullwidth-2x_R1MRr5rgb_8s0AW1X_soKM.png) -The **Flutter Full-Width** **button** specifies the button should be in full width of the screen. By setting a f**ullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right side. Default **fullWidthButton** set to `false`. +The **Flutter Full-Width** **button** specifies the button should be in full width of the screen. By setting a f**ullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right side. Default **fullWidthButton** set to `false`. ```dart import 'package:getwidget/getwidget.dart'; @@ -123,11 +124,11 @@ GFButton( ), ``` -Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline Button** also. +Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline Button** also. ## Flutter Square Outline2x Button -![Flutter Square Outline2x Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-2x\_-CHfawHE8\_05mmWBq_il.png) +![Flutter Square Outline2x Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-2x_-CHfawHE8_05mmWBq_il.png) **Flutter Outline2x Button** describes the Button with a transparent background and a visible border with 2x border width. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline2x`**. @@ -142,4 +143,5 @@ GFButton( ), ``` -Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline2x Button** also. +Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Outline2x Button** also. + diff --git a/src/gf-button/standard-button.md b/src/gf-button/standard-button.md index bdaca22..f189471 100644 --- a/src/gf-button/standard-button.md +++ b/src/gf-button/standard-button.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- Flutter Elevated Button looks like a solid button with slightly rounded corners. GF Button has all the variants like an outline, Transparent, Disable, @@ -7,17 +8,17 @@ description: >- # Flutter Elevated Button -![Flutter Elevated Button Widget UI Kit ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Standard_buttons\_-\_solid_bfYdW7r4D.png) +![Flutter Elevated Button Widget UI Kit ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Standard_buttons_-_solid_bfYdW7r4D.png) -The **GF Button** is a **Flutter Elevated button** that has a solid background fill color and the button triggers whenever the action is passed into it. +The **GF Button** is a **Flutter Elevated button** that has a solid background fill color and the button triggers whenever the action is passed into it. The default **GF button** **shape** is set to `GFButtonShape.standard` so that we will be able to get the standard shaped button with solid background color with slightly rounded corners. ## Flutter Elevated Solid Button -![Flutter Elevated Solid Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid-button-2x\_1mtTU6eHS_d9pt0\_fS_g.png) +![Flutter Elevated Solid Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/solid-button-2x_1mtTU6eHS_d9pt0_fS_g.png) -By default, **button** **type** is set to **Flutter Solid Button**`GFButtonType.solid` so, we can get buttons that have a **solid background color** with slightly rounded corners. +By default, **button** **type** is set to **Flutter Solid Button**`GFButtonType.solid` so, we can get buttons that have a **solid background color** with slightly rounded corners. The **callback** is called when the button is tapped. By adding a callback to the **onPressed** parameter it enables the button. @@ -32,7 +33,7 @@ The **callback** is called when the button is tapped. By adding a callback to th ## Flutter Elevated Disabled Button -![Flutter Elevated Disabled Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/disabled-button-2x_BF_NVpDS8\_LvFp8btIa2.png) +![Flutter Elevated Disabled Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/disabled-button-2x_BF_NVpDS8_LvFp8btIa2.png) **Flutter Elevated Disable Button** is achieved when the callback and **onPressed** are null, then the button will be disabled. Default **GFButton** will be disabled as **onPressed** is set to null. @@ -47,9 +48,9 @@ GFButton( ## Flutter Elevated Transparent Button -![Flutter Elevated Transparent Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/transparent-button-2x_CnsR7pkJx\_1foWmNnyos.png) +![Flutter Elevated Transparent Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/transparent-button-2x_CnsR7pkJx_1foWmNnyos.png) -In **GFButton** by adding **type,`GFButtonType.transparent`** we will get the transparent button. Default GFButton **type** will be `GFButtonType.solid`. +In **GFButton** by adding **type,`GFButtonType.transparent`** we will get the transparent button. Default GFButton **type** will be `GFButtonType.solid`. ```dart import 'package:getwidget/getwidget.dart'; @@ -79,9 +80,9 @@ GFButton( ## Flutter Elevated Full-Width Button -![Flutter Elevated Block Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/fullwidth-icon-button-2x-1\_rsx_EmmVZ_A_wcghxKaW.png) +![Flutter Elevated Block Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/fullwidth-icon-button-2x-1_rsx_EmmVZ_A_wcghxKaW.png) -The **Flutter Elevated Full-Width** **button** specifies the button should be in full width of the screen. By setting a **fullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right side. Default **fullWidthButton** set to `false`. +The **Flutter Elevated Full-Width** **button** specifies the button should be in full width of the screen. By setting a **fullWidthButton** state,`true` it will change the button to a Full-width button with rounded corners and no border on the left or right side. Default **fullWidthButton** set to `false`. ```dart import 'package:getwidget/getwidget.dart'; @@ -109,7 +110,7 @@ GFButton( ## Flutter Elevated Outline Button -![Flutter Elevated Outline Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-2x-1\_LtgeZktSN_Id3QwQtR2I.png) +![Flutter Elevated Outline Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-2x-1_LtgeZktSN_Id3QwQtR2I.png) The **Flutter Elevated Outline Button** describes the Button with a transparent background and a visible border. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline`**. @@ -123,11 +124,11 @@ GFButton( ), ``` -Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Elevated Outline Button** also. +Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works well in **Elevated Outline Button** also. ## Flutter Elevated Outline2x Button -![Flutter Elevated Outline2x Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-2x-1\_LtgeZktSN_Id3QwQtR2I.png) +![Flutter Elevated Outline2x Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/outline-2x-2x-1_LtgeZktSN_Id3QwQtR2I.png) **The Flutter Elevated Outline2x Button** describes the Button with a transparent background and a visible border with 2x border width. This button can be easily found in GFButton by adding **type** as **`GFButtonType.outline2x`**. @@ -142,3 +143,4 @@ GFButton( ``` Above mentioned properties like `size`, `blockButton`, `fullWidthButton`, enabling and disabling of button works fine in **Outline2x Button** also. + diff --git a/src/gf-card.md b/src/gf-card.md index 08a28a3..0e7f0ab 100644 --- a/src/gf-card.md +++ b/src/gf-card.md @@ -1,18 +1,23 @@ --- +sidebarDepth: 2 description: >- - GF Flutter Card Widget is a customized widget that can use with Image , Avatar - , Icon, Button, and ready-to-use custom widget in your app. + GF Flutter Card Widget that has more than 20+ predesign custom cards ready to + use in your app. +image: >- + https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Cards___with_avatar_JFmx-k0gX.png +canonicalUrl: https://docs.getwidget.dev/gf-card + --- -# GF Custom Flutter Card +# GF Flutter Card -![GF Flutter Card Widget ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Cards\_\_\_with\_avatar\_JFmx-k0gX.png) +![GF Flutter Card Widget ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Cards___with_avatar_JFmx-k0gX.png) -## GF Flutter Card Example +### GF Flutter Card Example -**GFCard** is a **Flutter Card** that is used in any section of the application to display certain types of information about the application. It can be simply used with a **title** and **buttons.** +**GFCard** is a **Flutter Card** that is used in any section of the application to display certain types of information about the application. It can be simply used with a **title** and **buttons.** -A **Flutter card** typically has a slight **border radius** and **box shadow** around it that gives a classic look to the card. It typically has two action buttons, some information and it can even contain images in it. +A **Flutter card** typically has a slight **border radius** and **box shadow** around it that gives a classic look to the card. It typically has two action buttons, some information and it can even contain images in it. The simple code of a Flutter card is shown below. @@ -45,11 +50,11 @@ buttonBar: GFButtonBar( ), ``` -## GF Flutter Cards with [Flutter Avatar](https://docs.getwidget.dev/gf-avatar/) +### GF Flutter Cards with [Flutter Avatar](gf-avatar.md) **GFCards** can be customized with different other types of **GFComponents**. **GFcards** give us data about the particular block. In addition, an **avatar** gives more precise information about the block. Hence **GFAvatar** can be used with **GFCard** to make a **GFCard Avatar.** -![GF Flutter Cards with Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Cards\_with\_avatars\_3x\_wiStZFa9L.png) +![GF Flutter Cards with Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Cards_with_avatars_3x_wiStZFa9L.png) Below is a simple example code of **GF Flutter Card with Avatar**: @@ -102,11 +107,11 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## GF Flutter Cards with OverlayImage +### GF Flutter Cards with OverlayImage **GFCards** has **OverlayImage** property wherein a **background image** can be placed and upon the image any widget like **Text**, **buttons** can be used as shown in the image below. -![GF Flutter Cards with OverlayImage](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/cards-with-image-overlays-2x\_XIMzf\_Bc7\_-j3RXaSa2.webp) +![GF Flutter Cards with OverlayImage](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/cards-with-image-overlays-2x_XIMzf_Bc7_-j3RXaSa2.webp) Below shows a simple example code for **GFCard with Card OverlayImage**: @@ -135,29 +140,30 @@ import 'package:getwidget/getwidget.dart'; color: Colors.white, ), ), - + ], ), ), ``` -## GFCard Custom Properties for Flutter Card: +### GFCard Custom Properties for Flutter Card: **GFCard** can be used like **GFCard with Avatar,** **GFCard with ImageOverlay,** and just a **GFCard**. To make the **GFcard** more flexible with your Flutter card. we have the below custom properties: -| Name | Description | -| ---------------------- | -------------------------------------------------------------------------------- | -| **titlePosition** | helps to set the title at top of the card | -| **color** | sets the background color of the card | -| **elevation** | controls the size of the shadow below the card | -| **shape** | the shape of the card | +| Name | Description | +| :--- | :--- | +| **titlePosition** | helps to set the title at top of the card | +| **color** | sets the background color of the card | +| **elevation** | controls the size of the shadow below the card | +| **shape** | the shape of the card | | **borderOnForeground** | whether to paint the shape of the border in front of the child, defaults to true | -| **clipBehaviour** | defines the clipping of the child | -| **margin** | defines the card's outer container margin | -| **padding** | defines the card's outer container padding | -| **semanticContainer** | represents a single semantic container, if false a collection of semantic nodes | -| **border** | to draw a border above the card | -| **borderRadius** | represents the rounded corners of the card | -| **colorFilter** | applies to the image before painting it | -| **boxFit** | how the image should be inscribed into the box | -| **imageOverlay** | display images as background with shaded overlay | +| **clipBehaviour** | defines the clipping of the child | +| **margin** | defines the card's outer container margin | +| **padding** | defines the card's outer container padding | +| **semanticContainer** | represents a single semantic container, if false a collection of semantic nodes | +| **border** | to draw a border above the card | +| **borderRadius** | represents the rounded corners of the card | +| **colorFilter** | applies to the image before painting it | +| **boxFit** | how the image should be inscribed into the box | +| **imageOverlay** | display images as background with shaded overlay | + diff --git a/src/gf-carousel.md b/src/gf-carousel.md index 98d1e49..38b1872 100644 --- a/src/gf-carousel.md +++ b/src/gf-carousel.md @@ -1,19 +1,23 @@ --- +sidebarDepth: 2 description: >- - GF Flutter Carousel widget custom develop Carousel widget that has the option - to use with image, text, Dot indicator, background image, fullscreen - properties to customize. + GF Flutter Carousel widget custom develop Carousel with many custom properties + full width, Full Size and use with Flutter Image component. +image: >- + https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Carousels-Images_AFXtfkE-M6u.png +canonicalUrl: https://docs.getwidget.dev/gf-carousel + --- -# GF Custom Flutter Carousel Widget +# GF Flutter Carousel Widget ![GF Flutter Carousel Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Carousels-Images_AFXtfkE-M6u.png) -## Flutter Carousel Slider/Flutter Image Slider +### Flutter Carousel Slider/Flutter Image Slider -**GFCarousel** is a **Flutter Carousel or Flutter Image Slider** widget that has a set of images that slides one after the other in a linear manner repeatedly in a given interval of time. **GFCarousel** can have any number of items in a slide and it can also have multiple images in one single slide. +**GFCarousel** is a **Flutter Carousel or Flutter Image Slider** widget that has a set of images that slides one after the other in a linear manner repeatedly in a given interval of time. **GFCarousel** can have any number of items in a slide and it can also have multiple images in one single slide. -![GF Flutter Carousel with Indicator ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Carousals-image-full_size\_3x_N5pQWCjljIz.png) +![GF Flutter Carousel with Indicator ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Carousals-image-full_size_3x_N5pQWCjljIz.png) Below is a simple example code for **Flutter Carousel with indicator** of one image in one slide of **GFCarousel** @@ -53,39 +57,39 @@ final List imageList = [ ), ``` -## Gf Flutter Carousel Custom Properties +### Gf Flutter Carousel Custom Properties The look and feel of the **GF carousel** widget for the Flutter app can be customized using the **GFCarousel** properties. Sliding items can be any type of list of widgets or a list of images. -| Name | Description | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **items** | widgets to be shown as a slider | -| **height** | set slide widget height and overrides any existing \[aspectRatio] | -| **aspectRatio** | aspect ratio is used if no height has been declared. Defaults to 16:9 aspect ratio | -| **viewportFraction** | The fraction of the viewport that each page should occupy. Defaults to 0.8, which means each page fills 80% of the slide | -| **autoPlay** | enables autoplay, sliding one page at a time. Use \[autoPlayInterval] to determent the frequency of slides. Defaults to false works only if `viewportFraction` set to 1.0, | -| **reverse** | reverse the order of items if set to true. Defaults to false | -| **autoPlayInterval** | sets Duration to determent the frequency of slides when \[autoPlay] is set to true. Defaults to 4 seconds | -| **autoPlayAnimationDuration** | animation-duration between two transitioning pages while in auto playback. Defaults to 800 ms | -| **autoPlayCurve** | determines the animation curve physics. Defaults to \[Curves.fastOutSlowIn] | -| **enlargeMainPage** | determines if the current page should be larger than the side images, creating a feeling of depth in the carousel. Defaults to false | -| **pauseAutoPlayOnTouch** | sets a timer on touch detected that pauses the autoplay with the given \[Duration]. Touch Detection is only active if \[autoPlay] is true | -| **pagination** | displays pagination on state true | -| **passiveIndicator** | slider pagination's passive color | -| **activeIndicator** | slider pagination's active color | -| **pagerSize** | pagination dots size can be defined using \[double] | -| **initialPage** | initial page to show when first creating the \[GFCarousel]. Defaults to 0 | -| **enableInfiniteScroll** | determines if slides should loop infinitely or be limited to item length. Defaults to true, i.e. infinite loop | -| **scrollDirection** | axis along which the page view scrolls. Defaults to \[Axis.horizontal] | -| **onPageChanged** | called whenever the page in the center of the viewport changes | - -## GF Flutter Carousel with Multiple Items +| Name | Description | +| :--- | :--- | +| **items** | widgets to be shown as a slider | +| **height** | set slide widget height and overrides any existing \[aspectRatio\] | +| **aspectRatio** | aspect ratio is used if no height has been declared. Defaults to 16:9 aspect ratio | +| **viewportFraction** | The fraction of the viewport that each page should occupy. Defaults to 0.8, which means each page fills 80% of the slide | +| **autoPlay** | enables autoplay, sliding one page at a time. Use \[autoPlayInterval\] to determent the frequency of slides. Defaults to false works only if `viewportFraction` set to 1.0, | +| **reverse** | reverse the order of items if set to true. Defaults to false | +| **autoPlayInterval** | sets Duration to determent the frequency of slides when \[autoPlay\] is set to true. Defaults to 4 seconds | +| **autoPlayAnimationDuration** | animation-duration between two transitioning pages while in auto playback. Defaults to 800 ms | +| **autoPlayCurve** | determines the animation curve physics. Defaults to \[Curves.fastOutSlowIn\] | +| **enlargeMainPage** | determines if the current page should be larger than the side images, creating a feeling of depth in the carousel. Defaults to false | +| **pauseAutoPlayOnTouch** | sets a timer on touch detected that pauses the autoplay with the given \[Duration\]. Touch Detection is only active if \[autoPlay\] is true | +| **pagination** | displays pagination on state true | +| **passiveIndicator** | slider pagination's passive color | +| **activeIndicator** | slider pagination's active color | +| **pagerSize** | pagination dots size can be defined using \[double\] | +| **initialPage** | initial page to show when first creating the \[GFCarousel\]. Defaults to 0 | +| **enableInfiniteScroll** | determines if slides should loop infinitely or be limited to item length. Defaults to true, i.e. infinite loop | +| **scrollDirection** | axis along which the page view scrolls. Defaults to \[Axis.horizontal\] | +| **onPageChanged** | called whenever the page in the center of the viewport changes | + +### GF Flutter Carousel with Multiple Items **GFCarousel** can have any number of images and it can also have multiple images in just one slide. It supports **multi-image** slides. The **ItemsCarousel** component of GetWidget for the Flutter app is a multi-section container with multiple items. Each section can be swiped or dragged between. It contains any number of items in each Slide component. ![GF ItemsCarousel](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Carousal-image-Multiple_items_UzBeEj6VU.png) -In the below code, the list of Images given to the children in the **GFItemsCarousel**, that allows sliding each slide container that contains multiple items. +In the below code, the list of Images given to the children in the **GFItemsCarousel**, that allows sliding each slide container that contains multiple items. The below code gives the default **Flutter** **multi-image slider component** @@ -118,10 +122,11 @@ final List imageList = [ ), ``` -## GF Flutter Carousel with Multiple Image Custom Properties +### GF Flutter Carousel with Multiple Image Custom Properties + +| Name | Description | +| :--- | :--- | +| **rowCount** | count of visible cells in each slide | +| **children** | widgets to be shown in slides | +| **itemHeight** | defines the height of an item | -| Name | Description | -| -------------- | ------------------------------------ | -| **rowCount** | count of visible cells in each slide | -| **children** | widgets to be shown in slides | -| **itemHeight** | defines the height of an item | diff --git a/src/gf-checkbox-listtile.md b/src/gf-checkbox-listtile.md index 279a519..351f7ae 100644 --- a/src/gf-checkbox-listtile.md +++ b/src/gf-checkbox-listtile.md @@ -6,15 +6,15 @@ description: >- # GF Flutter CheckboxListTile -![GF Flutter CheckboxListTile Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner-Checkbox_list_tile\_2x_C8edTv6HW.png) +![GF Flutter CheckboxListTile Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner-Checkbox_list_tile_2x_C8edTv6HW.png) -## GF Flutter CheckBoxListTile +### GF Flutter CheckBoxListTile **GFCheckBoxListTile** is a **Flutter CheckBoxList Tile** that is a list of items wherein the user can check or uncheck the items in the list. It allows users to select one or more options inside the list. **GFCheckBoxListTile** can also be positioned right or left of the screen according to the need. The example code with an **avatar** of **Flutter CheckboxListTile** is as shown below. -![GF Flutter CheckboxListTile with Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Checkbox_list_tile\_3x_pjFO-T5\_W.png) +![GF Flutter CheckboxListTile with Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Checkbox_list_tile_3x_pjFO-T5_W.png) ```dart bool isChecked = false; @@ -43,32 +43,33 @@ GFCheckboxListTile( ), ``` -## **GF Flutter CheckBoxListTile** Custom Properties +### **GF Flutter CheckBoxListTile** Custom Properties The Look and feel of the **GFCheckboxListTile** can be customized using the **GFCheckboxListTile** properties. -| Name | Description | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **titleText** | type of \[String] used to pass text, alternative to title property and gets higher priority than the title | -| **subTitleText** | type of \[String] used to pass text, alternative to subtitle property and gets higher priority than the subtitle | -| **color** | GFListTile's background color. Can be given \[Color] or \[GFColors] | -| **avatar** | type of \[Widget] or \[GFAvatar] used to create a rounded user profile | -| **title** | title to display inside the \[GFListTile]. | -| **subTitle** | subtitle to display inside the \[GFListTile]. | -| **description** | description to display inside the \[GFListTile]. | -| **position** | allows the user to set the position of the checkbox to start or end | -| **margin** | defines the margin of GFListTile | -| **padding** | defines the padding of GFListTile | -| **type** | type of \[GFCheckboxType] which is of four types is basic, square, circular, and custom | -| **size** | type of \[double] which is GFSize ie, small, medium, and large and can use any double value | -| **activeBgColor** | type of \[Color] used to change the backgroundColor of the active checkbox | -| **inactiveBgColor** | type of \[Color] used to change the backgroundColor of the inactive checkbox | -| **activeBorderColor** | type of \[Color] used to change the border color of the active checkbox | -| **inactiveBorderColor** | type of \[Color] used to change the border color of the inactive checkbox | -| **onChanged** | Called when the user checks or unchecks the checkbox. | -| **value** | Used to set the current state of the checkbox | -| **activeIcon** | type of Widget used to change the checkbox's active icon | -| **inactiveIcon** | type of \[Widget] used to change the checkbox's inactive icon | -| **customBgColor** | type of \[Color] used to change the background color of the custom active checkbox only | -| **selected** | To have the list tile appear selected when the checkbox is checked, pass the same value to both. Normally, this property is left to its default value, false. | -| **autofocus** | on the true state, this widget will be selected as the initial focus when no other node in its scope is currently focused | +| Name | Description | +| :--- | :--- | +| **titleText** | type of \[String\] used to pass text, alternative to title property and gets higher priority than the title | +| **subTitleText** | type of \[String\] used to pass text, alternative to subtitle property and gets higher priority than the subtitle | +| **color** | GFListTile's background color. Can be given \[Color\] or \[GFColors\] | +| **avatar** | type of \[Widget\] or \[GFAvatar\] used to create a rounded user profile | +| **title** | title to display inside the \[GFListTile\]. | +| **subTitle** | subtitle to display inside the \[GFListTile\]. | +| **description** | description to display inside the \[GFListTile\]. | +| **position** | allows the user to set the position of the checkbox to start or end | +| **margin** | defines the margin of GFListTile | +| **padding** | defines the padding of GFListTile | +| **type** | type of \[GFCheckboxType\] which is of four types is basic, square, circular, and custom | +| **size** | type of \[double\] which is GFSize ie, small, medium, and large and can use any double value | +| **activeBgColor** | type of \[Color\] used to change the backgroundColor of the active checkbox | +| **inactiveBgColor** | type of \[Color\] used to change the backgroundColor of the inactive checkbox | +| **activeBorderColor** | type of \[Color\] used to change the border color of the active checkbox | +| **inactiveBorderColor** | type of \[Color\] used to change the border color of the inactive checkbox | +| **onChanged** | Called when the user checks or unchecks the checkbox. | +| **value** | Used to set the current state of the checkbox | +| **activeIcon** | type of Widget used to change the checkbox's active icon | +| **inactiveIcon** | type of \[Widget\] used to change the checkbox's inactive icon | +| **customBgColor** | type of \[Color\] used to change the background color of the custom active checkbox only | +| **selected** | To have the list tile appear selected when the checkbox is checked, pass the same value to both. Normally, this property is left to its default value, false. | +| **autofocus** | on the true state, this widget will be selected as the initial focus when no other node in its scope is currently focused | + diff --git a/src/gf-checkbox.md b/src/gf-checkbox.md index c01c99c..8978bec 100644 --- a/src/gf-checkbox.md +++ b/src/gf-checkbox.md @@ -6,9 +6,9 @@ description: >- # GF Flutter Checkbox -![GF Flutter Checkbox Widget ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner\_-Checkboxes\_2x_WNmE4bx73H.png) +![GF Flutter Checkbox Widget ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner_-Checkboxes_2x_WNmE4bx73H.png) -## GF Flutter Checkbox and Example +### GF Flutter Checkbox and Example **GFCheckbox** is a **Flutter CheckBox widget** that permits the user to select one or more than one option in a given set of lists. It can have any number of possible ticks. The user can check and uncheck on the boxes provided. @@ -29,7 +29,7 @@ GFCheckbox( ), ``` -## GF Basic Flutter Checkbox +### GF Basic Flutter Checkbox **GFCheckbox** has many kinds and one of them is a **basic** or **standard** type of **checkbox**. Here the box will have a slight border-radius around it as shown in the below image. The code below gives a basic or standard checkbox @@ -81,7 +81,7 @@ GFCard( ), ``` -## GF Square Flutter Checkbox +### GF Square Flutter Checkbox **GFCheckbox** has **square** type checkbox. Here the box will not have any border radius and it will be in a square shape as shown in the below image. Hence the name **Square Checkbox**. The below code shows the example of a square checkbox: @@ -136,7 +136,7 @@ GFCard( ), ``` -## Flutter Circle Checkbox: +### Flutter Circle Checkbox: **GFCheckbox** has **circle-type** checkbox. Here the box will have a circle shape as shown in the below image. Hence the name **Circular Checkbox**. The below code shows the example of a circular checkbox: @@ -190,7 +190,7 @@ GFCard( ), ``` -## GF Flutter Custom Checkbox +### GF Flutter Custom Checkbox **GFCheckbox** has **custom** type checkbox. Here the box will have any custom items like **icons** or **background color** when the box is checked as shown in the below image. Hence the name **Custom Checkbox**. The below code shows the example of a square checkbox: @@ -244,22 +244,23 @@ GFCard( ), ``` -## GF Flutter Checkbox Custom Properties +### GF Flutter Checkbox Custom Properties The Look and feel of the **GFCheckbox** can be customized using the GFCheckbox properties. -| Name | Description | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------- | -| **type** | type of \[GFCheckboxType] which is of four type is basic, square, circular and custom | -| **size** | type of \[double] which is GFSize ie, small, medium and large and can use any double value | -| **activeBgColor** | type of \[Color] used to change the backgroundColor of the active checkbox | -| **inactiveBgColor** | type of \[Color] used to change the backgroundColor of the inactive checkbox | -| **activeBorderColor** | type of \[Color] used to change the border color of the active checkbox | -| **inactiveBorderColor** | type of \[Color] used to change the border color of the inactive checkbox | -| **onChanged** | called when the user checks or unchecks the checkbox. | -| **value** | used to set the current state of the checkbox | -| **activeIcon** | type of \[Widget] used to change the checkbox's active icon | -| **inactiveIcon** | type of \[Widget] used to change the checkbox's inactive icon | -| **customBgColor** | type of \[Color] used to change the background color of the custom active checkbox only | -| **autofocus** | on true state this widget will be selected as the initial focus when no other node in its scope is currently focused | -| **focusNode** | an optional focus node to use as the focus node for this widget. | +| Name | Description | +| :--- | :--- | +| **type** | type of \[GFCheckboxType\] which is of four type is basic, square, circular and custom | +| **size** | type of \[double\] which is GFSize ie, small, medium and large and can use any double value | +| **activeBgColor** | type of \[Color\] used to change the backgroundColor of the active checkbox | +| **inactiveBgColor** | type of \[Color\] used to change the backgroundColor of the inactive checkbox | +| **activeBorderColor** | type of \[Color\] used to change the border color of the active checkbox | +| **inactiveBorderColor** | type of \[Color\] used to change the border color of the inactive checkbox | +| **onChanged** | called when the user checks or unchecks the checkbox. | +| **value** | used to set the current state of the checkbox | +| **activeIcon** | type of \[Widget\] used to change the checkbox's active icon | +| **inactiveIcon** | type of \[Widget\] used to change the checkbox's inactive icon | +| **customBgColor** | type of \[Color\] used to change the background color of the custom active checkbox only | +| **autofocus** | on true state this widget will be selected as the initial focus when no other node in its scope is currently focused | +| **focusNode** | an optional focus node to use as the focus node for this widget. | + diff --git a/src/gf-drawer.md b/src/gf-drawer.md index 2d6f2f6..2e19f89 100644 --- a/src/gf-drawer.md +++ b/src/gf-drawer.md @@ -1,8 +1,13 @@ --- +sidebarDepth: 2 description: >- GF Flutter Drawer Widget is a navigation drawer that slides in from the side of the current view. GFDrawer can be the perfect option to provide common navigation options. +image: >- + https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Drawer_RdU7oyGaW.png +canonicalUrl: https://docs.getwidget.dev/gf-drawer + --- # GF Flutter Drawer Widget @@ -39,14 +44,14 @@ GFDrawer( The look and feel of the **GFDrawer** can be customized using the GFDrawer properties. -| Name | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------- | -| **child** | displays the drawer items | -| **color** | defines the background color of the drawer | -| **gradient** | the gradient can be used for transforming gradient shaders without applying the same transform to the entire canvas. | -| **backgroundImage** | the background image can be added to the drawer | -| **colorFilter** | composited layer that applies a color filter to its children | -| **elevation** | controls the size of the shadow below the drawer. | +| Name | Description | +| :--- | :--- | +| **child** | displays the drawer items | +| **color** | defines the background color of the drawer | +| **gradient** | the gradient can be used for transforming gradient shaders without applying the same transform to the entire canvas. | +| **backgroundImage** | the background image can be added to the drawer | +| **colorFilter** | composited layer that applies a color filter to its children | +| **elevation** | controls the size of the shadow below the drawer. | ## GF Flutter Drawer Header and its Usage: @@ -101,12 +106,13 @@ import 'package:getwidget/getwidget.dart'; The look and feel of the **GFDrawerHeader** can be customized using the **GFDrawerHeader** properties. -| Name | Description | -| ------------------------- | --------------------------------------------------------------------------------- | -| **decoration** | defines the background color of the drawer header | -| **margin** | refers to the margin around the drawer header | -| **child** | widget to be placed inside the drawer header, inset by the \[padding] | +| Name | Description | +| :--- | :--- | +| **decoration** | defines the background color of the drawer header | +| **margin** | refers to the margin around the drawer header | +| **child** | widget to be placed inside the drawer header, inset by the \[padding\] | | **currentAccountPicture** | widget placed in the upper-left corner that represents the current user's account | -| **otherAccountsPictures** | list of widgets that represent the current user's other accounts | -| **duration** | the duration for animations of the \[decoration] | -| **curve** | the curve for animations of the \[decoration] | +| **otherAccountsPictures** | list of widgets that represent the current user's other accounts | +| **duration** | the duration for animations of the \[decoration\] | +| **curve** | the curve for animations of the \[decoration\] | + diff --git a/src/gf-dropdown.md b/src/gf-dropdown.md index 0253251..5dbad8c 100644 --- a/src/gf-dropdown.md +++ b/src/gf-dropdown.md @@ -8,11 +8,11 @@ description: >- **GFDropdown** is a **Flutter Dropdown** **Widget** that lets users select from the number of items and display the selected item. It displays a list of items in the overlay dropdown fashion. It has an arrow button to show the dropdown list. -![GF Flutter Dropdown Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/GW_Drop_down\_2x_R8HnHoR9S.png) +![GF Flutter Dropdown Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/GW_Drop_down_2x_R8HnHoR9S.png) -## GF Flutter Dropdown List Usage +### GF Flutter Dropdown List Usage -The simple example code of a basic **GFDropdown** is as shown below. +The simple example code of a basic **GFDropdown** is as shown below. ![GF Flutter Dropdown Widgets](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/DROP_DOWN-BASIC_pl2dlIIoM.gif) @@ -52,13 +52,13 @@ Container( ), ``` -## GF Custom Flutter Dropdown Menu +### GF Custom Flutter Dropdown Menu GFDropdown features allow users to create a customized dropdown for the more flexible and interactive UI design. ![Custom Flutter Dropdown Widgets](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Dropdown-custom_YPxBvxKZJbi.gif) -### Flutter Custom Dropdown Menu List Example Source code +#### Flutter Custom Dropdown Menu List Example Source code ```dart String dropdown; @@ -96,32 +96,144 @@ Container( ), ``` -## **GF Flutter Dropdown Menu** Custom Properties +### **GF Flutter Dropdown Menu** Custom Properties The look and feel of the **GFDropdown** can be customized using the GFDropdown properties. -| Name | Description | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **icon** | The widget to use for the drop-down button's icon. Defaults to an \[Icon] with the \[Icons.arrow_drop_down] glyph. | -| **elevation** | The z-coordinate at which to place the menu when open. | -| **value** | The value of the currently selected \[DropdownMenuItem]. | -| **border** | Defines the border of dropdown button | -| **padding** | Defines the padding given inside the dropdown | -| **hint** | A placeholder widget that is displayed by the dropdown button. | -| **disabledHint** | A message to show when the dropdown is disabled. | -| **onChanged** |

Called when the user selects an item.

If the [onChanged] callback is null or the list of [DropdownButton.items] is null then the dropdown button will be disabled,

| -| **onTap** | Called when the dropdown button is tapped. | -| **style** | Defaults to the \[TextTheme.subtitle1] value of the current \[ThemeData.textTheme] of the current \[Theme]. | -| **underline** | The widget to use for drawing the drop-down button's underline. | -| **iconDisabledColor** | The color of any \[Icon] descendant of \[icon] if this button is disabled, i.e. if \[onChanged] is null. | -| **iconEnabledColor** | The color of any \[Icon] descendant of \[icon] if this button is enabled, i.e. if \[onChanged] is defined. | -| **iconSize** | The size to use for the drop-down button's down arrow icon button. | -| **isDense** | Reduce the button's height. | -| **isExpanded** | Set the dropdown's inner contents to horizontally fill its parent. | -| **itemHeight** | defines the height of the menu items | -| **focusColor** | The color for the button's \[Material] when it has the input focus. | -| **dropdownColor** | Defines the background color of the dropdown. | -| **borderRadius** | Defines the border radius of the dropdown. | -| **dropdownButtonColor** | Defines the background color of the dropdownButton. | -| **autofocus** |

On true state it should focus itself if nothing else is already focused.

Defaults to false

| -| **focusNode** | Defines the keyboard focus for this widget. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
icon + The widget to use for the drop-down button's icon. Defaults to an + [Icon] with the [Icons.arrow_drop_down] glyph.
elevation + The z-coordinate at which to place the menu when open.
value + The value of the currently selected [DropdownMenuItem].
border + Defines the border of dropdown button
padding + Defines the padding given inside the dropdown
hint + A placeholder widget that is displayed by the dropdown button.
disabledHint + A message to show when the dropdown is disabled.
onChanged + +

Called when the user selects an item.

+

If the [onChanged] callback is null or the list of [DropdownButton.items] + is null then the dropdown button will be disabled,

+
onTap + Called when the dropdown button is tapped.
style + Defaults to the [TextTheme.subtitle1] value of the current [ThemeData.textTheme] + of the current [Theme].
underline + The widget to use for drawing the drop-down button's underline.
iconDisabledColor + The color of any [Icon] descendant of [icon] if this button is disabled, + i.e. if [onChanged] is null.
iconEnabledColor + The color of any [Icon] descendant of [icon] if this button is enabled, + i.e. if [onChanged] is defined.
iconSize + The size to use for the drop-down button's down arrow icon button.
isDense + Reduce the button's height.
isExpanded + Set the dropdown's inner contents to horizontally fill its parent.
itemHeight + defines the height of the menu items
focusColor + The color for the button's [Material] when it has the input focus.
dropdownColor + Defines the background color of the dropdown.
borderRadius + Defines the border radius of the dropdown.
dropdownButtonColor + Defines the background color of the dropdownButton.
autofocus + +

On true state it should focus itself if nothing else is already focused.

+

Defaults to false

+
focusNode + Defines the keyboard focus for this widget.
+ diff --git a/src/gf-floating-widget.md b/src/gf-floating-widget.md index f7e0e8b..ae3639a 100644 --- a/src/gf-floating-widget.md +++ b/src/gf-floating-widget.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Floating Widget is a simple widget that acts as the outer wrapper to other kinds of components. @@ -21,9 +22,9 @@ return Scaffold( ) ``` -## GF Flutter Floating Widget Position +### GF Flutter Floating Widget Position -**GFFloating Widget** comes with two types of positions ie, **horizontalPosition** and **VerticalPosition** in which the **child** of **GF** **Floating** widget can be placed anywhere inside the body ie, it basically floats in the body, and hence the name GF Floating Widget. +**GFFloating Widget** comes with two types of positions ie, **horizontalPosition** and **VerticalPosition** in which the **child** of **GF** **Floating** widget can be placed anywhere inside the body ie, it basically floats in the body, and hence the name GF Floating Widget. The below code shows how to use **Floating Widget positions** @@ -49,11 +50,12 @@ return Scaffold( ) ``` -## GF Flutter Floating Widget Custom Properties +### GF Flutter Floating Widget Custom Properties The look and feel of **GFFloating Widget** can be changed using the below properties: -| Name | Description | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **showBlurness** | showBlurness defines whether the body should be blur or not when showing popups, error messages, etc whenever the **child** property is used in GF Floating widget. The showBlurness defaults to `false`. | -| **blurnessColor** | defines how much blur backgroundColor should be whenever the **child** is used and when showBlurness is `true` | +| Name | Description | +| :--- | :--- | +| **showBlurness** | showBlurness defines whether the body should be blur or not when showing popups, error messages, etc whenever the **child** property is used in GF Floating widget. The showBlurness defaults to `false`. | +| **blurnessColor** | defines how much blur backgroundColor should be whenever the **child** is used and when showBlurness is `true` | + diff --git a/src/gf-image.md b/src/gf-image.md index fc92f31..36d7c8a 100644 --- a/src/gf-image.md +++ b/src/gf-image.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- Gf Flutter Image image is custom widget to handle image and their design in flutter. It comes with 25+ Custom properties to use according to requirement. @@ -12,7 +13,7 @@ description: >- **GFImage** supports and manages the images to be displayed on run time. It has the following types of images which can be used in any application. -## GF Flutter Asset Image +### GF Flutter Asset Image **Asset image** is used to display the images stored locally in the assets folder. Below is a simple example code of an asset image. @@ -26,7 +27,7 @@ GFImageOverlay( ) ``` -## GF Flutter Network Image +### GF Flutter Network Image **Network image** is used to display an image from the internet. Hence the passing parameter for the image will be as shown in the below code. @@ -40,11 +41,11 @@ GFImageOverlay( ) ``` -## GF Flutter Image Overlay +### GF Flutter Image Overlay I**mage Overlay** is used to set the image in the **background** and text in the **foreground** with the `colorFilter` property that takes two colors, and outputs one color -![Flutter Image Overlay](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Images\_-\_basic\_3x_uHCFyLq7s.png) +![Flutter Image Overlay](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Images_-_basic_3x_uHCFyLq7s.png) **Flutter Image overlay example Code** @@ -63,11 +64,11 @@ GFImageOverlay( ), ``` -## GF Flutter Circle Image +### GF Flutter Circle Image A **Circular Image** is an image with a circle-shaped border. It is widely used in any profile screen to display the profile picture. -![Flutter Circular Image](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Images-circular\_3x_DOdazHv_R.png) +![Flutter Circular Image](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Images-circular_3x_DOdazHv_R.png) **Flutter Circle image example Code** @@ -83,18 +84,19 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## GF Flutter Image Custom Properties +### GF Flutter Image Custom Properties The custom properties of **GFImage** are given below to customize the look and feel of the image. -| Name | Description | -| ---------------- | --------------------------------------------- | -| **height** | defines the height of the image | -| **width** | defines the width of the image | -| **color** | defines the background color of the image | -| **margin** | image's outer container margin | -| **padding** | image's outer container padding | -| **alignment** | to align the child within the image | -| **boxFit** | how to image should be inscribed into the box | -| **borderRadius** | the corners of the image | -| **border** | the border above the image | +| Name | Description | +| :--- | :--- | +| **height** | defines the height of the image | +| **width** | defines the width of the image | +| **color** | defines the background color of the image | +| **margin** | image's outer container margin | +| **padding** | image's outer container padding | +| **alignment** | to align the child within the image | +| **boxFit** | how to image should be inscribed into the box | +| **borderRadius** | the corners of the image | +| **border** | the border above the image | + diff --git a/src/gf-intro-screen.md b/src/gf-intro-screen.md index d9a3c3f..07493a7 100644 --- a/src/gf-intro-screen.md +++ b/src/gf-intro-screen.md @@ -7,7 +7,7 @@ description: >- # GF Introduction Screen -## GF Flutter Intro Screen or Welcome Screen +### GF Flutter Intro Screen or Welcome Screen **GFIntro Screen** is a **Flutter Introduction Screen** that has sliders and gives information about the application. It can have as many slides as the application needs. It is a user-friendly widget that pops upon opening the application to give a brief introduction to the app. @@ -131,7 +131,7 @@ List slides() { } ``` -## GF Flutter Intro Screen Bottom Navigation Bar +### GF Flutter Intro Screen Bottom Navigation Bar **GF IntroScreen Bottom NavigationBar** is a bottom bar that sits at the bottom end of the screen. This component contains pagination and buttons for navigation. It has many features for customizing the bottom navigation bar. @@ -157,14 +157,14 @@ GFIntroScreen( pageCount: slideList.length, currentIndex: initialPage, ), -), +), ``` -## GF Flutter Introduction Custom Screen +### GF Flutter Introduction Custom Screen -![](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Introscreens-half\_-Ptb6PZ669.gif) +![](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Introscreens-half_-Ptb6PZ669.gif) -**GFIntroScreen** and **GFIntroScreenBottomNavigationBar** components features allows user to create customized **intro screen** with or without BottomNavigationBar for the more flexible and interactive UI design. +**GFIntroScreen** and **GFIntroScreenBottomNavigationBar** components features allows user to create customized **intro screen** with or without BottomNavigationBar for the more flexible and interactive UI design. ```dart late PageController _pageController; @@ -289,55 +289,56 @@ List slides() { } ``` -## **GF Flutter IntroScreen** Custom Properties +### **GF Flutter IntroScreen** Custom Properties Look and feel of the **GFIntroScreen** can be customized using the **GFIntroScreen** properties. -| Name | Description | -| ----------------------------------------- | ----------------------------------------------------------------------------- | -| **slides** | defines the list of slides | -| **pageController** | allows one to control \[GFIntroScreen] slides | -| **color** | defines background color of the \[GFIntroScreen] slides | -| **height** | defines \[GFIntroScreen] slides height | -| **width** | defines \[GFIntroScreen] slides width | -| **borderRadius** | defines \[GFIntroScreen] border radius to defines slides shape | -| **border** | defines \[GFIntroScreen] slides border | -| **introScreenBottomNavigationBar** _\*\*_ | defines \[GFIntroScreen]'s bottom navigation bar | -| **showIntroScreenBottomNavigationBar** | on true state, displays \[GFIntroScreenBottomNavigationBar], defaults to true | -| **currentIndex** | defines the currentIndex of \[GFIntroScreen] slides, default value is 0 | -| **pageCount** | defines the length of \[GFIntroScreen] slides, default value is 0 | -| **child** | defines \[GFIntroScreenBottomNavigationBar]'s child, it takes any widget | -| **navigationBarHeight** | defines \[GFIntroScreenBottomNavigationBar] height | -| **navigationBarWidth** | defines \[GFIntroScreenBottomNavigationBar] width | -| **navigationBarPadding** | defines \[GFIntroScreenBottomNavigationBar] padding | -| **navigationBarMargin** | defines \[GFIntroScreenBottomNavigationBar] margin | -| **navigationBarColor** | defines \[GFIntroScreenBottomNavigationBar] color | -| **navigationBarShape** | defines the shape of \[GFIntroScreenBottomNavigationBar] | -| **onForwardButtonTap** | called when the \[forwardButtonText] is tapped | -| **onBackButtonTap** | called when the \[backButtonText] is tapped | -| **onDoneTap** | called when the \[doneButtonText] is tapped | -| **onSkipTap** | called when the \[skipButtonText] is tapped | -| **backButton** | takes any Widget to define the backButton widget | -| **forwardButton** | takes any Widget to define the forwardButton widget | -| **doneButton** | takes any Widget to define the doneButton widget | -| **skipButton** | takes any Widget to define the skipButton widget | -| **backButtonText** | takes String to define backButton text | -| **forwardButtonText** | takes String to define forwardButton text | -| **doneButtonText** | takes String to define doneButton text | -| **skipButtonText** | takes String to define skipButton text | -| **skipButtonTextStyle** | defines the skipButton textStyle | -| **doneButtonTextStyle** | defines the doneButton textStyle | -| **backButtonTextStyle** | defines the backButton textStyle | -| **forwardButtonTextStyle** | defines the forwardButton textStyle | -| **showDivider** | on true state, displays \[Divider], defaults to true | -| **showButton** | on true state, displays buttons, defaults to true | -| **showPagination** | on true state, displays pagination, defaults to true | -| **dividerHeight** | defines divider height | -| **dividerThickness** | defines divider thickness | -| **dividerColor** | defines divider color | -| **dotShape** | defines pagination shape | -| **inactiveColor** | defines pagination inactive color | -| **activeColor** | defines pagination active color | -| **dotHeight** | defines pagination height | -| **dotWidth** | defines pagination width | -| **dotMargin** | defines pagination in between space | +| Name | Description | +| :--- | :--- | +| **slides** | defines the list of slides | +| **pageController** | allows one to control \[GFIntroScreen\] slides | +| **color** | defines background color of the \[GFIntroScreen\] slides | +| **height** | defines \[GFIntroScreen\] slides height | +| **width** | defines \[GFIntroScreen\] slides width | +| **borderRadius** | defines \[GFIntroScreen\] border radius to defines slides shape | +| **border** | defines \[GFIntroScreen\] slides border | +| **introScreenBottomNavigationBar** _****_ | defines \[GFIntroScreen\]'s bottom navigation bar | +| **showIntroScreenBottomNavigationBar** | on true state, displays \[GFIntroScreenBottomNavigationBar\], defaults to true | +| **currentIndex** | defines the currentIndex of \[GFIntroScreen\] slides, default value is 0 | +| **pageCount** | defines the length of \[GFIntroScreen\] slides, default value is 0 | +| **child** | defines \[GFIntroScreenBottomNavigationBar\]'s child, it takes any widget | +| **navigationBarHeight** | defines \[GFIntroScreenBottomNavigationBar\] height | +| **navigationBarWidth** | defines \[GFIntroScreenBottomNavigationBar\] width | +| **navigationBarPadding** | defines \[GFIntroScreenBottomNavigationBar\] padding | +| **navigationBarMargin** | defines \[GFIntroScreenBottomNavigationBar\] margin | +| **navigationBarColor** | defines \[GFIntroScreenBottomNavigationBar\] color | +| **navigationBarShape** | defines the shape of \[GFIntroScreenBottomNavigationBar\] | +| **onForwardButtonTap** | called when the \[forwardButtonText\] is tapped | +| **onBackButtonTap** | called when the \[backButtonText\] is tapped | +| **onDoneTap** | called when the \[doneButtonText\] is tapped | +| **onSkipTap** | called when the \[skipButtonText\] is tapped | +| **backButton** | takes any Widget to define the backButton widget | +| **forwardButton** | takes any Widget to define the forwardButton widget | +| **doneButton** | takes any Widget to define the doneButton widget | +| **skipButton** | takes any Widget to define the skipButton widget | +| **backButtonText** | takes String to define backButton text | +| **forwardButtonText** | takes String to define forwardButton text | +| **doneButtonText** | takes String to define doneButton text | +| **skipButtonText** | takes String to define skipButton text | +| **skipButtonTextStyle** | defines the skipButton textStyle | +| **doneButtonTextStyle** | defines the doneButton textStyle | +| **backButtonTextStyle** | defines the backButton textStyle | +| **forwardButtonTextStyle** | defines the forwardButton textStyle | +| **showDivider** | on true state, displays \[Divider\], defaults to true | +| **showButton** | on true state, displays buttons, defaults to true | +| **showPagination** | on true state, displays pagination, defaults to true | +| **dividerHeight** | defines divider height | +| **dividerThickness** | defines divider thickness | +| **dividerColor** | defines divider color | +| **dotShape** | defines pagination shape | +| **inactiveColor** | defines pagination inactive color | +| **activeColor** | defines pagination active color | +| **dotHeight** | defines pagination height | +| **dotWidth** | defines pagination width | +| **dotMargin** | defines pagination in between space | + diff --git a/src/gf-loader.md b/src/gf-loader.md index fb9ff08..04b4e49 100644 --- a/src/gf-loader.md +++ b/src/gf-loader.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Loader is a progress indicator that spins to indicate that the application is busy. It usually progresses along a circle. GF widget comes @@ -11,7 +12,7 @@ description: >- **GFLoader** is a **Flutter Loader** circular indicator that will be loading continuously that indicates something is about to load. -## GF Flutter Loader and its Usage: +### GF Flutter Loader and its Usage: **GFLoader** is a Flutter circular spinner that spins over time which signifies that some part of the program is about to get executed. @@ -22,13 +23,13 @@ import 'package:getwidget/getwidget.dart'; GFLoader(), ``` -## GF Flutter Loaders Custom Type +### GF Flutter Loaders Custom Type There are five different types of loaders namely **android**, **ios,** **circle**, **square,** and **custom** -## **Flutter IOS Spinner** +### **Flutter IOS Spinner** -![Flutter IOS Loader/Spinner](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/iOS_loaders\_3x\_\_6iEhhCjnN.png) +![Flutter IOS Loader/Spinner](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/iOS_loaders_3x__6iEhhCjnN.png) A simple **ios** loader in which the type of the loader should be passed to **ios**. The code is as shown below. @@ -39,9 +40,9 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## Flutter Circular Loader +### Flutter Circular Loader -![Flutter Circular Loader/Spinner](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Circular\_3x_qSfMlOtBk.png) +![Flutter Circular Loader/Spinner](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Circular_3x_qSfMlOtBk.png) A simple **circular** **shape loader** in which the type of the loader should be passed to **circle**. The code is as shown below. @@ -53,9 +54,9 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## Flutter Square Loader/Spinner +### Flutter Square Loader/Spinner -![Flutter Square Loader/Spinner](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Square_loader\_3x_QsRsYryOlL.png) +![Flutter Square Loader/Spinner](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Square_loader_3x_QsRsYryOlL.png) A simple **square** **shape loade**r in which the type of the loader should be passed to **square**. The code is as shown below. @@ -67,7 +68,7 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## Gf Flutter Custom Loader +### Gf Flutter Custom Loader Apart from the four types described above, there is a **custom loader** in which we can pass text, icons, images, etc as the parameters to show a variety of customized loaders. The below code shows the custom loader with a gif in it. @@ -80,7 +81,7 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## Flutter Custom Loader with Icon +### Flutter Custom Loader with Icon The below example code shows Flutter custom loaders with icons in them. @@ -95,7 +96,7 @@ GFLoader( ), ``` -## Flutter Custom Loader with text +### Flutter Custom Loader with text We can also pass **text** as a parameter to the custom loader. The below code shows a simple usage. @@ -110,17 +111,18 @@ GFLoader( ), ``` -## GFLoader Custom Properties: +### GFLoader Custom Properties: The look and feel of **GFLoader** can be customized using the below properties. -| Name | Description | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| **child** | child of type \[Widget] used only for **custom** type and is prominent over loaderIconOne, loaderIconTwo and loaderIconThree in **custom** type | -| **duration** | defines the animation duration of the loader only in **circle** and **square** type | -| **loaderColorOne** | defines the color of the first dot in only **circle** or **square** type of loader | -| **loaderColorTwo** | defines the color of the second dot in only **circle** or **square** type of loader | -| **loaderColorThree** | defines the color of the third dot in only **circle** or **square** type of loader | -| **androidLoaderColor** | defines the color of the android type loader only | -| **loaderstrokeWidth** | defines the stroke width of the android type loader only | -| **size** | defines the size of the loader ie, `small`, `medium` and `large` and it is applicable to android ios, circle and square type loaders | +| Name | Description | +| :--- | :--- | +| **child** | child of type \[Widget\] used only for **custom** type and is prominent over loaderIconOne, loaderIconTwo and loaderIconThree in **custom** type | +| **duration** | defines the animation duration of the loader only in **circle** and **square** type | +| **loaderColorOne** | defines the color of the first dot in only **circle** or **square** type of loader | +| **loaderColorTwo** | defines the color of the second dot in only **circle** or **square** type of loader | +| **loaderColorThree** | defines the color of the third dot in only **circle** or **square** type of loader | +| **androidLoaderColor** | defines the color of the android type loader only | +| **loaderstrokeWidth** | defines the stroke width of the android type loader only | +| **size** | defines the size of the loader ie, `small`, `medium` and `large` and it is applicable to android ios, circle and square type loaders | + diff --git a/src/gf-multiselect.md b/src/gf-multiselect.md index 8dd4d0a..6d9318c 100644 --- a/src/gf-multiselect.md +++ b/src/gf-multiselect.md @@ -8,9 +8,9 @@ description: >- **GF Flutter Multiselect** lets users select multiple items from the number of **Checkbox ListTile items** and display selected items in the TitleTile box. It displays a list of items in the overlay dropdown fashion. -![GF Flutter Multi Select Checkbox ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/GW_multiselect\_2x_z65vAFaPW.png) +![GF Flutter Multi Select Checkbox ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/GW_multiselect_2x_z65vAFaPW.png) -### **GF Flutter Multiselect Dropdown **Usage +### **GF Flutter Multiselect Dropdown** Usage The simple example demo code of a basic **GFMultiselect** is as shown below. @@ -58,7 +58,7 @@ GFMultiSelect( The below example code gives the basic **Flutter Multi Select option in flutter app** -![Custom Flutter Multi Select option](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Multi_select\_-custom\_18gtv6LENAJ.gif) +![Custom Flutter Multi Select option](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Multi_select_-custom_18gtv6LENAJ.gif) ```dart Container( @@ -97,40 +97,198 @@ Container( ), ``` -### **GF Flutter Multiselect **Custom Properties - -The look and feel of the **GFMultiselect **can be customized using the **GFMultiselect** properties. - -| Name | Description | -| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **items** | defines the list of items the user can select | -| **onSelect** | callback when user select item from the dropdown, in callback we get list of selected items index | -| **dropdownTitleTileText** | type of \[String] to define the dropdownTitleTile title | -| **dropdownTitleTileTextStyle** | type of \[TextStyle] to define the textStyle of \[dropDownTitleTileText] | -| **dropdownTitleTileHintText** | type of \[String] to define the dropdownTitleTile hint text | -| **dropdownTitleTileHintTextStyle** | type of \[TextStyle] to define the textStyle of \[dropDownTitleTileHintTextStyle] | -| **dropdownTitleTileBorderRadius** | defines the border radius of the dropdownTitleTile | -| **dropdownTitleTileBorder** | defines the border of the dropdownTitleTile. | -| **dropdownTitleTileColor** | defines the background color of dropdownButton | -| **hideDropdownUnderline** | on true state, it hides the Dropdown Underline border defaults value is false | -| **dropdownUnderlineBorder** | defines the border of the Dropdown Underline border | -| **dropdownTitleTileMargin** | defines the dropdownTitleTile margin | -| **dropdownTitleTilePadding** | defines the dropdownTitleTile padding | -| **expandedIcon** | defines the dropdownTitleTile's trailing icon when dropdown is visible | -| **collapsedIcon** | defines the dropdownTitleTile's trailing icon when dropdown is not visible | -| **submitButton** | defines the button in the dropdown | -| **color** | defines dropdown checkbox ListTile's background color. Can be given \[Color] or \[GFColors] | -| **avatar** | type of \[Widget] or \[GFAvatar] used to defines dropdown checkbox ListTile's leading | -| **margin** | defines the margin of dropdown checkbox ListTile | -| **padding** | defines the padding of dropdown checkbox ListTile | -| **type** | defines dropdown ListTile's checkbox type type of \[GFCheckboxType] which is of four type is basic, sqaure, circular and custom | -| **size** | defines dropdown ListTile's checkbox size type of \[double] which is GFSize ie, small, medium and large and can use any double value | -| **activeBgColor** | defines dropdown ListTile's checkbox background color when its active type of \[Color] used to change the backgroundColor of the active checkbox | -| **inactiveBgColor** | defines dropdown ListTile's checkbox background color when its inactive type of \[Color] used to change the backgroundColor of the inactive checkbox | -| **activeBorderColor** |

defines dropdown ListTile's checkbox border color when its active

type of [Color] used to change the border color of the active checkbox

| -| **inactiveBorderColor** |

defines dropdown ListTile's checkbox border color when its inactive

type of [Color] used to change the border color of the inactive checkbox

| -| **activeIcon** |

defines dropdown ListTile's checkbox's active icon

type of [Widget] used to change the checkbox's active icon

| -| **inactiveIcon** |

defines dropdown ListTile's checkbox's inactive icon

type of [Widget] used to change the checkbox's inactive icon

| -| **customBgColor** | type of \[Color] used to change the background color of the custom active checkbox only | -| **selected** | To have the list tile appear selected when the checkbox is checked, pass the same value to both. Normally, this property is left to its default value, false. | -| **dropdownBgColor** | defines the background color of the dropdown. Can be given \[Color] or \[GFColors] | +### **GF Flutter Multiselect** Custom Properties + +The look and feel of the **GFMultiselect** can be customized using the **GFMultiselect** properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
items + defines the list of items the user can select
onSelect + callback when user select item from the dropdown, in callback we get list + of selected items index
dropdownTitleTileText + type of [String] to define the dropdownTitleTile title
dropdownTitleTileTextStyle + type of [TextStyle] to define the textStyle of [dropDownTitleTileText]
dropdownTitleTileHintText + type of [String] to define the dropdownTitleTile hint text
dropdownTitleTileHintTextStyle + type of [TextStyle] to define the textStyle of [dropDownTitleTileHintTextStyle]
dropdownTitleTileBorderRadius + defines the border radius of the dropdownTitleTile
dropdownTitleTileBorder + defines the border of the dropdownTitleTile.
dropdownTitleTileColor + defines the background color of dropdownButton
hideDropdownUnderline + on true state, it hides the Dropdown Underline border defaults value is + false
dropdownUnderlineBorder + defines the border of the Dropdown Underline border
dropdownTitleTileMargin + defines the dropdownTitleTile margin
dropdownTitleTilePadding + defines the dropdownTitleTile padding
expandedIcon + defines the dropdownTitleTile's trailing icon when dropdown is visible
collapsedIcon + defines the dropdownTitleTile's trailing icon when dropdown is not + visible
submitButton + defines the button in the dropdown
color + defines dropdown checkbox ListTile's background color. Can be given + [Color] or [GFColors]
avatar + type of [Widget] or [GFAvatar] used to defines dropdown checkbox ListTile's + leading
margin + defines the margin of dropdown checkbox ListTile
padding + defines the padding of dropdown checkbox ListTile
type + defines dropdown ListTile's checkbox type type of [GFCheckboxType] + which is of four type is basic, sqaure, circular and custom
size + defines dropdown ListTile's checkbox size type of [double] which + is GFSize ie, small, medium and large and can use any double value
activeBgColor + defines dropdown ListTile's checkbox background color when its active + type of [Color] used to change the backgroundColor of the active checkbox
inactiveBgColor + defines dropdown ListTile's checkbox background color when its inactive + type of [Color] used to change the backgroundColor of the inactive checkbox
activeBorderColor + +

defines dropdown ListTile's checkbox border color when its active

+

type of [Color] used to change the border color of the active checkbox

+
inactiveBorderColor + +

defines dropdown ListTile's checkbox border color when its inactive

+

type of [Color] used to change the border color of the inactive checkbox

+
activeIcon + +

defines dropdown ListTile's checkbox's active icon

+

type of [Widget] used to change the checkbox's active icon

+
inactiveIcon + +

defines dropdown ListTile's checkbox's inactive icon

+

type of [Widget] used to change the checkbox's inactive icon

+
customBgColor + type of [Color] used to change the background color of the custom active + checkbox only
selected + To have the list tile appear selected when the checkbox is checked, pass + the same value to both. Normally, this property is left to its default + value, false.
dropdownBgColor + defines the background color of the dropdown. Can be given [Color] or + [GFColors]
+ diff --git a/src/gf-progress-bar.md b/src/gf-progress-bar.md index 5a1d271..5fc1d10 100644 --- a/src/gf-progress-bar.md +++ b/src/gf-progress-bar.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Progress Bar is a simple Widget that shows the progress of any task along a line or along a Circle progress bar. @@ -12,13 +13,13 @@ description: >- **GFProgress bar** can be of two types, a **simple linear progress bar** or a **Circular Progress bar.** -## **Flutter Linear Progress Bar Indicator** +### **Flutter Linear Progress Bar Indicator** A **Linear Progress Bar** is a progress bar that has a straight line of progress percentage shown on them. The below code shows a simple **Linear** **progress** **bar** with some defined properties of the progress bar. -![Flutter Basic Progress Bar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/linear\_2\_3x_tbrWidKp\_.png) +![Flutter Basic Progress Bar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/linear_2_3x_tbrWidKp_.png) -### Flutter Line Progress Bar indicator example code +#### Flutter Line Progress Bar indicator example code ```dart import 'package:getwidget/getwidget.dart'; @@ -30,13 +31,13 @@ A **Linear Progress Bar** is a progress bar that has a straight line of progress ) ``` -## Flutter Circle Progress Bar Indicator +### Flutter Circle Progress Bar Indicator -The **Circular progress bar** is as same as the **linear progress bar** with some additional properties added to the code structure. The **Circle Progress Bar** will be basically a circle in shape and the percentage will be shown inside the circle as shown in the below image. The below code shows a simple circular progress bar. +The **Circular progress bar** is as same as the **linear progress bar** with some additional properties added to the code structure. The **Circle Progress Bar** will be basically a circle in shape and the percentage will be shown inside the circle as shown in the below image. The below code shows a simple circular progress bar. -![Flutter Circular Progress Bar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Circular\_1\_3x_NfFXiyxXyz.png) +![Flutter Circular Progress Bar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Circular_1_3x_NfFXiyxXyz.png) -### Flutter Circle Progress Bar Indicator example code +#### Flutter Circle Progress Bar Indicator example code ```dart import 'package:getwidget/getwidget.dart'; @@ -51,13 +52,13 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## Flutter Progress bar with Child property +### Flutter Progress bar with Child property The **progress bar** can be customized to show the percentage of progress completed. To show the progress percentage we can use child property which is a Widget type and can be a text, icon, image, etc. The below code shows how a **child's property** can be used as text to show the progress percentage. -![Progress bar with Child property](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/circular\_2\_3x_tY\_3Jy7Fw.png) +![Progress bar with Child property](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/circular_2_3x_tY_3Jy7Fw.png) -### Flutter Custom Progress Bar Indicator with child example code +#### Flutter Custom Progress Bar Indicator with child example code ```dart import 'package:getwidget/getwidget.dart'; @@ -76,11 +77,11 @@ GFProgressBar( ) ``` -## Flutter Progress bar with leading and trailing icons +### Flutter Progress bar with leading and trailing icons The **progress bar** can be used with **leading** and **trailing** icons to show the level of progress percent from 0 to 1. The below code shows leading and trailing icons in a **Linear Progress bar.** -![Progress bar with leading and trailing icons](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Linear\_1\_3x\_2oh4hQejHD.png) +![Progress bar with leading and trailing icons](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Linear_1_3x_2oh4hQejHD.png) ```dart import 'package:getwidget/getwidget.dart'; @@ -99,28 +100,29 @@ GFProgressBar( ) ``` -## GF FLutter Progress Bar Custom Properties +### GF FLutter Progress Bar Custom Properties The Look and feel of **GFProgressBar** can be customised using the following properties: -| Name | Description | -| ----------------------------- | ------------------------------------------------------------------------------------------------------------- | -| **percentage** | type of double which should be from 0 to 1 to indicate the progress percentage | -| **radius** | type of double used to show the radius of the Circular Progress Bar | -| **width** | defines the width of the progress bar | -| **type** | type of \[GFProgressType] which changes the shape of progress bar ie , linear or circular | -| **lineHeight** | defines the height of the progress bar | -| **circleWidth** | defines the thickness of the circle's arc in Circular Progress bar | -| **circleStartAngle** | defines the angle on which the circle starts to progress in degrees.(ie 0.0, 45.0, 90.0 etc) | -| **animation** | type of bool which allows the progress line to animate when the percentage value is changed, default is false | -| **animationDuration** | duration of animation in milliseconds , applicable only if animation is true | -| **alignment** | used to align the leading and trailing widget which the progress bar evenly | -| **padding** | defines the padding of the progress bar | -| **animateFromLastPercentage** | type of bool which is used to animate the progress bar from the last percentage value set | -| **linearGradient** | linear gardient colors given to the progress line color | -| **autoLive** | set to false if you don't want to preserve the state of the widget , default is true | -| **fromRightToLeft** | set to true if you want to animate the linear progress bar from right to left | -| **mask** | Creates a mask filter that takes the progress shape being drawn and blurs it | -| **clipLinearGradient** | set to true if you want to display only a part of \[linearGradient] based on percentage value, | -| **progressHeadType** | type of \[GFProgressHeadType] which changes the shape of the progress head ie , circular or sqaure | -| **reverse** | type to bool which is used to display the progress in reverse direction | +| Name | Description | +| :--- | :--- | +| **percentage** | type of double which should be from 0 to 1 to indicate the progress percentage | +| **radius** | type of double used to show the radius of the Circular Progress Bar | +| **width** | defines the width of the progress bar | +| **type** | type of \[GFProgressType\] which changes the shape of progress bar ie , linear or circular | +| **lineHeight** | defines the height of the progress bar | +| **circleWidth** | defines the thickness of the circle's arc in Circular Progress bar | +| **circleStartAngle** | defines the angle on which the circle starts to progress in degrees.\(ie 0.0, 45.0, 90.0 etc\) | +| **animation** | type of bool which allows the progress line to animate when the percentage value is changed, default is false | +| **animationDuration** | duration of animation in milliseconds , applicable only if animation is true | +| **alignment** | used to align the leading and trailing widget which the progress bar evenly | +| **padding** | defines the padding of the progress bar | +| **animateFromLastPercentage** | type of bool which is used to animate the progress bar from the last percentage value set | +| **linearGradient** | linear gardient colors given to the progress line color | +| **autoLive** | set to false if you don't want to preserve the state of the widget , default is true | +| **fromRightToLeft** | set to true if you want to animate the linear progress bar from right to left | +| **mask** | Creates a mask filter that takes the progress shape being drawn and blurs it | +| **clipLinearGradient** | set to true if you want to display only a part of \[linearGradient\] based on percentage value, | +| **progressHeadType** | type of \[GFProgressHeadType\] which changes the shape of the progress head ie , circular or sqaure | +| **reverse** | type to bool which is used to display the progress in reverse direction | + diff --git a/src/gf-radio-listtile.md b/src/gf-radio-listtile.md index f7d0793..f43b673 100644 --- a/src/gf-radio-listtile.md +++ b/src/gf-radio-listtile.md @@ -9,15 +9,15 @@ description: >- **Flutter RadioBoxListTile** is a list of items wherein the user can check or uncheck only one item in the list. It allows users to select only one option inside the list. GFRadioBoxListTile can also be positioned right or left of the screen according to the need. -![GF Flutter RadioList Tile Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner-Radio_list_tile\_2x_FZN65RIJw.png) +![GF Flutter RadioList Tile Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner-Radio_list_tile_2x_FZN65RIJw.png) -## GF Flutter RadioListTile and its Usage: +### GF Flutter RadioListTile and its Usage: -**GFRadioListTile** can have a simple list with title or two lines of title and description or with **GFAvatar**. +**GFRadioListTile** can have a simple list with title or two lines of title and description or with **GFAvatar**. The simple code with an **avatar** of **GFRadioListTile** is as shown below. -![GF RadioListTile with Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Radiolist_tile\_3x\_0KLlfYPXn.png) +![GF RadioListTile with Avatar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Radiolist_tile_3x_0KLlfYPXn.png) ```dart int groupValue = 0; @@ -62,42 +62,209 @@ GFRadioListTile( ), ``` -## **GF Flutter RadioList Tile** Custom Properties +### **GF Flutter RadioList Tile** Custom Properties The look and feel of the **GFRadioListTile** can be customized using the GFRadioListTile properties. -| Name | Description | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **type** | type of \[GFRadioType] which is of four types is basic, suaure, circular, and custom | -| **size** | type of \[double] which is GFSize ie, small, medium, and large and can use any double value | -| **radioColor** | type pf \[Color] used to change the checkcolor when the radio button is active | -| **activeBgColor** | type of \[Color] used to change the backgroundColor of the active radio button | -| **inactiveBgColor** | type of \[Color] used to change the backgroundColor of the inactive radio button | -| **activeBorderColor** | type of \[Color] used to change the border color of the active radio button | -| **inactiveBorderColor** | type of \[Color] used to change the border color of the inactive radio button | -| **onChanged** | Called when the user checks or unchecks the radio button | -| **position** | allows the user to set the position of the radiobutton to start or end | -| **activeIcon** | type of Widget used to change the radio button's active icon | -| **inactiveIcon** | type of \[Widget] used to change the radio button's inactive icon | -| **customBgColor** | type of \[Color] used to change the background color of the custom active radio button only | -| **autofocus** | on true state, this widget will be selected as the initial focus when no other node in its scope is currently focused | -| **focusNode** | an optional focus node to use as the focus node for this widget. | -| **value** | The value represented by this radio button. | -| **groupValue** | The currently selected value for a group of radio buttons. Radio button is considered selected if its \[value] matches the \[groupValue]. | -| **toggleable** | sets the radio value | -| **titleText** | type of \[String] used to pass text, alternative to title property and gets higher priority than the title | -| **subTitleText** | type of \[String] used to pass text, alternative to subtitle property and gets higher priority than the subtitle | -| **color** | The GFListTile's background color. Can be given \[Color] or \[GFColors] | -| **avatar** | type of \[Widget] or \[GFAvatar] used to create a rounded user profile | -| **title** | The title to display inside the \[GFListTile]. | -| **subTitle** | The subtitle to display inside the \[GFListTile]. | -| **description** | The description to display inside the \[GFListTile]. | -| **icon** | The icon to display inside the \[GFListTile]. | -| **margin** | defines the margin of GFListTile | -| **padding** | defines the padding of GFListTile | -| **enabled** |

Whether this list tile is interactive. If false, this list tile is styled with the disabled color from the current [Theme] and the [onTap] and [onLongPress] callbacks are

inoperative.

| -| **onTap** | Called when the user taps this list tile. Inoperative if \[enabled] is false. | -| **onLongPress** | Called when the user long-presses on this list tile. Inoperative if \[enabled] is false. | -| **selected** |

If this tile is also [enabled] then icons and text are rendered with the same color.

By default the selected color is the theme's primary color. The selected color can be overridden with a [ListTileTheme].

| -| **focusColor** | The color for the tile's \[Material] when it has the input focus. | -| **hoverColor** | The color for the tile's \[Material] when a pointer is hovering over it. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
type + type of [GFRadioType] which is of four types is basic, suaure, circular, + and custom
size + type of [double] which is GFSize ie, small, medium, and large and can + use any double value
radioColor + type pf [Color] used to change the checkcolor when the radio button is + active
activeBgColor + type of [Color] used to change the backgroundColor of the active radio + button
inactiveBgColor + type of [Color] used to change the backgroundColor of the inactive radio + button
activeBorderColor + type of [Color] used to change the border color of the active radio button
inactiveBorderColor + type of [Color] used to change the border color of the inactive radio + button
onChanged + Called when the user checks or unchecks the radio button
position + allows the user to set the position of the radiobutton to start or end
activeIcon + type of Widget used to change the radio button's active icon
inactiveIcon + type of [Widget] used to change the radio button's inactive icon
customBgColor + type of [Color] used to change the background color of the custom active + radio button only
autofocus + on true state, this widget will be selected as the initial focus when + no other node in its scope is currently focused
focusNode + an optional focus node to use as the focus node for this widget.
value + The value represented by this radio button.
groupValue + The currently selected value for a group of radio buttons. Radio button + is considered selected if its [value] matches the [groupValue].
toggleable + sets the radio value
titleText + type of [String] used to pass text, alternative to title property and + gets higher priority than the title
subTitleText + type of [String] used to pass text, alternative to subtitle property and + gets higher priority than the subtitle
color + The GFListTile's background color. Can be given [Color] or [GFColors]
avatar + type of [Widget] or [GFAvatar] used to create a rounded user profile
title + The title to display inside the [GFListTile].
subTitle + The subtitle to display inside the [GFListTile].
description + The description to display inside the [GFListTile].
icon + The icon to display inside the [GFListTile].
margin + defines the margin of GFListTile
padding + defines the padding of GFListTile
enabled + +

Whether this list tile is interactive. If false, this list tile is styled + with the disabled color from the current [Theme] and the [onTap] and [onLongPress] + callbacks are

+

inoperative.

+
onTap + Called when the user taps this list tile. Inoperative if [enabled] is + false.
onLongPress + Called when the user long-presses on this list tile. Inoperative if [enabled] + is false.
selected + +

If this tile is also [enabled] then icons and text are rendered with the + same color.

+

By default the selected color is the theme's primary color. The selected + color can be overridden with a [ListTileTheme].

+
focusColor + The color for the tile's [Material] when it has the input focus.
hoverColor + The color for the tile's [Material] when a pointer is hovering over + it.
+ + + diff --git a/src/gf-radio.md b/src/gf-radio.md index a7931b5..dc99188 100644 --- a/src/gf-radio.md +++ b/src/gf-radio.md @@ -9,13 +9,13 @@ description: >- **Flutter RadioBox Button** permits the user to select only one option in any two sets of mutual options. The radio button has to be checked or unchecked only once in a given set of options. -![GF Flutter Radio Button Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner-Radio_button\_\_2x_L9eu2FM1aw.png) +![GF Flutter Radio Button Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Docs_banner-Radio_button__2x_L9eu2FM1aw.png) -## GF Flutter Radio Button and its Usage +### GF Flutter Radio Button and its Usage -**GFRadioButton** has to be checked only one at a time and other options are by default unchecked as radio buttons allow only one option to be checked at a time. +**GFRadioButton** has to be checked only one at a time and other options are by default unchecked as radio buttons allow only one option to be checked at a time. -The code below gives a simple **Flutter radio button**. +The code below gives a simple **Flutter radio button**. ```dart int groupValue = 0; @@ -35,9 +35,9 @@ GFRadio( ), ``` -## Flutter Basic Radio Button +### Flutter Basic Radio Button -**GFRadioButton** has many types in it and the basic type is a circular radio button. The shape is of a circle and hence the name circular and it is a basic type as shown in the below image. Let us look at the example below +**GFRadioButton** has many types in it and the basic type is a circular radio button. The shape is of a circle and hence the name circular and it is a basic type as shown in the below image. Let us look at the example below ![Flutter Basic Circlular Radio Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Basic_radio_button_x_CcqpvKba.png) @@ -104,11 +104,11 @@ GFCard( )), ``` -## Flutter Square Radio Button +### Flutter Square Radio Button **GFRadioButton** can be a square type. The outer border will not have any border-radius and the shape will be of a square and hence the name square radio button as shown in the below image. Let us look at the example below : -![Flutter Square Radio Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Square_radio_buttons_UOSD9OSpo\_.png) +![Flutter Square Radio Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Square_radio_buttons_UOSD9OSpo_.png) ```dart int groupValue = 0; @@ -178,13 +178,13 @@ GFCard( )), ``` -## Flutter Custom Radio Button Type-1 +### Flutter Custom Radio Button Type-1 -**GFRadioButton** can be a custom type. The outer border will have little border-radius and comes in different sizes as shown in the below image. +**GFRadioButton** can be a custom type. The outer border will have little border-radius and comes in different sizes as shown in the below image. -Let us look at the example demo code for the custom radio button below : +Let us look at the example demo code for the custom radio button below : -![Flutter Custom Radio Button Type 1](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Custom_radio\_1\_5pRZCct_LM.png) +![Flutter Custom Radio Button Type 1](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Custom_radio_1_5pRZCct_LM.png) ```dart int groupValue = 0; @@ -252,13 +252,13 @@ GFCard( )), ``` -## Flutter Custom Radio Button Type 2 +### Flutter Custom Radio Button Type 2 -**GFRadioButton** can be a custom type 2 wherein the checked box can be any type of widget like an icon, background color, etc as shown in the image below. +**GFRadioButton** can be a custom type 2 wherein the checked box can be any type of widget like an icon, background color, etc as shown in the image below. Let us look at the example code below : -![Flutter Custom Radio Button Type 2](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Custom_radio\_2\_fSkHHSP4Wa.png) +![Flutter Custom Radio Button Type 2](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Custom_radio_2_fSkHHSP4Wa.png) ```dart int groupValue = 0; @@ -331,25 +331,28 @@ GFCard( )), ``` -## GF Flutter Radio Button Custom Properties +### GF Flutter Radio Button Custom Properties The look and feel of the **GFRadio button** can be customized using the GFRadio properties. -| Name | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| **type** | type of \[GFRadioType] which is of four type is basic, sqaure, circular and custom | -| **size** | type of \[double] which is GFSize ie, small, medium and large and can use any double value | -| **radioColor** | type pf \[Color] used to change the checkcolor when the radio button is active | -| **activeBgColor** | type of \[Color] used to change the backgroundColor of the active radio button | -| **inactiveBgColor** | type of \[Color] used to change the backgroundColor of the inactive radio button | -| **activeBorderColor** | type of \[Color] used to change the border color of the active radio button | -| **inactiveBorderColor** | type of \[Color] used to change the border color of the inactive radio button | -| **onChanged** | Called when the user checks or unchecks the radio button | -| **activeIcon** | type of Widget used to change the radio button's active icon | -| **inactiveIcon** | type of \[Widget] used to change the radio button's inactive icon | -| **customBgColor** | type of \[Color] used to change the background color of the custom active radio button only | -| **autofocus** | on true state this widget will be selected as the initial focus when no other node in its scope is currently focused | -| **focusNode** | an optional focus node to use as the focus node for this widget. | -| **value** | The value represented by this radio button. | -| **groupValue** | The currently selected value for a group of radio buttons. Radio button is considered selected if its \[value] matches the \[groupValue]. | -| **toggleable** | sets the radio value | +| Name | Description | +| :--- | :--- | +| **type** | type of \[GFRadioType\] which is of four type is basic, sqaure, circular and custom | +| **size** | type of \[double\] which is GFSize ie, small, medium and large and can use any double value | +| **radioColor** | type pf \[Color\] used to change the checkcolor when the radio button is active | +| **activeBgColor** | type of \[Color\] used to change the backgroundColor of the active radio button | +| **inactiveBgColor** | type of \[Color\] used to change the backgroundColor of the inactive radio button | +| **activeBorderColor** | type of \[Color\] used to change the border color of the active radio button | +| **inactiveBorderColor** | type of \[Color\] used to change the border color of the inactive radio button | +| **onChanged** | Called when the user checks or unchecks the radio button | +| **activeIcon** | type of Widget used to change the radio button's active icon | +| **inactiveIcon** | type of \[Widget\] used to change the radio button's inactive icon | +| **customBgColor** | type of \[Color\] used to change the background color of the custom active radio button only | +| **autofocus** | on true state this widget will be selected as the initial focus when no other node in its scope is currently focused | +| **focusNode** | an optional focus node to use as the focus node for this widget. | +| **value** | The value represented by this radio button. | +| **groupValue** | The currently selected value for a group of radio buttons. Radio button is considered selected if its \[value\] matches the \[groupValue\]. | +| **toggleable** | sets the radio value | + + + diff --git a/src/gf-rating.md b/src/gf-rating.md index 12bc5d1..2064ad7 100644 --- a/src/gf-rating.md +++ b/src/gf-rating.md @@ -1,25 +1,26 @@ --- +sidebarDepth: 2 description: >- GF Flutter Rating Widget is a row of star icons, one can touch or drag the row of icons to set the rating. It has many custom properties to customize like - Color,Icon. + Color, Icon. --- # GF Flutter Rating ![GF Flutter Rating Bar Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Ratings_IgiXBsGTL.png) -## GF Flutter Rating Bar +### GF Flutter Rating Bar **Flutter rating** allows the user to start rating any of the products using the start icons as rating icons. -## GF Flutter Rating Star and its Usage +### GF Flutter Rating Star and its Usage -**GF Flutter Star Rating** is a very simple widget that permits the users to rate with the help of star icons. Users can touch the icons to start rating. +**GF Flutter Star Rating** is a very simple widget that permits the users to rate with the help of star icons. Users can touch the icons to start rating. The simple code of a basic **GF Start Rating** is as shown below. -![GF Flutter Star Rating Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/ratings-2x_Sn4SxO-12\_l0-nhQy_z.png) +![GF Flutter Star Rating Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/ratings-2x_Sn4SxO-12_l0-nhQy_z.png) ```dart double _rating = 3; @@ -34,9 +35,9 @@ GFRating( ), ``` -## GF Flutter Rating with TextField +### GF Flutter Rating with TextField -If `showTextForm` true, it displays the GF Rating bar with a text field, that takes user input to show the rating. +If `showTextForm` true, it displays the GF Rating bar with a text field, that takes user input to show the rating. The simple example code of the **rating bar with textform** is shown below. @@ -66,26 +67,27 @@ GFRating( ), ``` -## GF Flutter Rating Bar Custom Properties: +### GF Flutter Rating Bar Custom Properties: The look and feel of the **GF Rating** can be customized using the GF Rating properties. -| Name | Description | -| -------------------- | ----------------------------------------------------------------------------------------------------- | -| **itemCount** | defines the total number of rating items | -| **color** | defines the color of items | -| **borderColor** | defines the border color of \[halfFilledIcon] | -| **size** | defines the size of items. GFSize can be used for size variations like small. medium. large | -| **allowHalfRating** | if true, allow half rating of items. Default it will be in a true state | -| **filledIcon** | defines the items when filled | -| **halfFilledIcon** | defines the items when half-filled | -| **defaultIcon** | defines the default items, when having filledIcon and halfFilledIcon | -| **spacing** | defines the space between items | -| **value** | defines the rating value | -| **onChanged** | return current rating whenever rating is updated | -| **showTextForm** | if true, shows rating \[TextFormField] with the rating bar, that allows the user input to show rating | -| **suffixIcon** | defines the design and function of rating \[TextFormField]'s suffix icon | -| **controller** | controls the \[TextField] Controller of rating \[TextFormField] | -| **inputDecorations** | defines the \[InputDecoration] of rating \[TextFormField] | -| **margin** | defines the margin of rating \[TextFormField] | -| **padding** | defines the padding of rating \[TextFormField] | +| Name | Description | +| :--- | :--- | +| **itemCount** | defines the total number of rating items | +| **color** | defines the color of items | +| **borderColor** | defines the border color of \[halfFilledIcon\] | +| **size** | defines the size of items. GFSize can be used for size variations like small. medium. large | +| **allowHalfRating** | if true, allow half rating of items. Default it will be in a true state | +| **filledIcon** | defines the items when filled | +| **halfFilledIcon** | defines the items when half-filled | +| **defaultIcon** | defines the default items, when having filledIcon and halfFilledIcon | +| **spacing** | defines the space between items | +| **value** | defines the rating value | +| **onChanged** | return current rating whenever rating is updated | +| **showTextForm** | if true, shows rating \[TextFormField\] with the rating bar, that allows the user input to show rating | +| **suffixIcon** | defines the design and function of rating \[TextFormField\]'s suffix icon | +| **controller** | controls the \[TextField\] Controller of rating \[TextFormField\] | +| **inputDecorations** | defines the \[InputDecoration\] of rating \[TextFormField\] | +| **margin** | defines the margin of rating \[TextFormField\] | +| **padding** | defines the padding of rating \[TextFormField\] | + diff --git a/src/gf-searchbar.md b/src/gf-searchbar.md index 8404345..e734e6f 100644 --- a/src/gf-searchbar.md +++ b/src/gf-searchbar.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter SearchBar represents a text field that can be used to search through a collection. @@ -12,11 +13,11 @@ description: >- **GFSearchBar** is a **search field** wherein the user enters few letters in order to search the words from the list provided in the search section. -**GFSearchBar** contains textfield for user input and the overlay container to show the search list collections. +**GFSearchBar** contains textfield for user input and the overlay container to show the search list collections. The simple code of a basic **GF Flutter SearchBar** is as shown below. -![Basic GF SearchBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Search\_1\_3x_n0E\_2KJ_v.png) +![Basic GF SearchBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Search_1_3x_n0E_2KJ_v.png) ```dart import 'package:getwidget/getwidget.dart'; @@ -57,13 +58,14 @@ GFSearchBar( The look and feel of the **GFSearchBar** can be customized using the **GFSearchBar** properties. -| Name | Description | -| --------------------------------- | ----------------------------------------------------------------- | -| **searchList** | List of \[text] or \[widget] reference for users | -| **overlaySearchListItemBuilder** | defines how the \[searchList] items look like in overlayContainer | -| **hideSearchBoxWhenItemSelected** | if true, it will hide the \[searchBox] | -| **overlaySearchListHeight** | defines the height of \[searchList] overlay container | -| **searchQueryBuilder** | can search and filter the \[searchList] | -| **noItemsFoundWidget** | displays the \[widget] when the search item failed | -| **onItemSelected** | defines what to do with onSelect \[SearchList] item | -| **searchBoxInputDecoration** | defines the input decoration of \[searchBox] | +| Name | Description | +| :--- | :--- | +| **searchList** | List of \[text\] or \[widget\] reference for users | +| **overlaySearchListItemBuilder** | defines how the \[searchList\] items look like in overlayContainer | +| **hideSearchBoxWhenItemSelected** | if true, it will hide the \[searchBox\] | +| **overlaySearchListHeight** | defines the height of \[searchList\] overlay container | +| **searchQueryBuilder** | can search and filter the \[searchList\] | +| **noItemsFoundWidget** | displays the \[widget\] when the search item failed | +| **onItemSelected** | defines what to do with onSelect \[SearchList\] item | +| **searchBoxInputDecoration** | defines the input decoration of \[searchBox\] | + diff --git a/src/gf-shimmer.md b/src/gf-shimmer.md index 051d171..03dd747 100644 --- a/src/gf-shimmer.md +++ b/src/gf-shimmer.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Shimmer gives a shimmery effect for the child, that can be used to indicate a loading status. GF Shimmer for a better design and user interface. @@ -14,7 +15,7 @@ description: >- ### How to Use Flutter Shimmer Effect using GetFlutter -![Flutter Shimmer Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Basic\_3x_pRKTr4X6\_r.png) +![Flutter Shimmer Animation](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Basic_3x_pRKTr4X6_r.png) The below code gives a simple **Flutter Shimmer effect** for children with the main color and secondary color. @@ -67,9 +68,9 @@ final Widget emptyBlock = Padding( ### GF Flutter Shimmer with Gradient -![GF Flutter Shimmer with Gradient](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/text\_3x_fzYT22T5N.png) +![GF Flutter Shimmer with Gradient](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/text_3x_fzYT22T5N.png) -The below code gives a Shimmer effect for children with Linear Gradient. It only takes Liner Gradient when `[showGradient`] is **true.** +The below code gives a Shimmer effect for children with Linear Gradient. It only takes Liner Gradient when `[showGradient`\] is **true.** ```dart GFShimmer( @@ -97,14 +98,15 @@ GFShimmer( The look and feel of **GFShimmer** can be customized using the below properties: -| Name | Description | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **child** | The child of type \[Widget] to display shimmer effect. | -| **duration** | Controls the speed of the shimmer effect. The default value is 1500 milliseconds. | -| **direction** | Controls the direction of the shimmer effect. The default direction is GFShimmerDirection.leftToRight. | -| **gradient** | Controls the \[child]'s shades of color using Linear gradient. Child \[Widget] only takes gradient color, If \[showGradient] is true. | -| **showShimmerEffect** | Controls animation effect, defaults true state that makes animation active. | -| **showGradient** | If true, takes gradient color \[gradient] for the \[child]'s shimmer effect. Default set to false. | -| **shimmerEffectCount** | Controls the animation shimmerEffectCount. The default value is '0', that displays child \[Widget]'s shimmer effect forever. | -| **mainColor** | Defines the main color of the \[child]'s shimmer effect. Child \[Widget] takes the main color, only if \[showGradient] is false. Default \[showGradient] will be false. | -| **secondaryColor** | Defines the secondary color of the \[child]'s shimmer effect. Child \[Widget] takes secondary color, only if \[showGradient] is false. Default \[showGradient] will be false. | +| Name | Description | +| :--- | :--- | +| **child** | The child of type \[Widget\] to display shimmer effect. | +| **duration** | Controls the speed of the shimmer effect. The default value is 1500 milliseconds. | +| **direction** | Controls the direction of the shimmer effect. The default direction is GFShimmerDirection.leftToRight. | +| **gradient** | Controls the \[child\]'s shades of color using Linear gradient. Child \[Widget\] only takes gradient color, If \[showGradient\] is true. | +| **showShimmerEffect** | Controls animation effect, defaults true state that makes animation active. | +| **showGradient** | If true, takes gradient color \[gradient\] for the \[child\]'s shimmer effect. Default set to false. | +| **shimmerEffectCount** | Controls the animation shimmerEffectCount. The default value is '0', that displays child \[Widget\]'s shimmer effect forever. | +| **mainColor** | Defines the main color of the \[child\]'s shimmer effect. Child \[Widget\] takes the main color, only if \[showGradient\] is false. Default \[showGradient\] will be false. | +| **secondaryColor** | Defines the secondary color of the \[child\]'s shimmer effect. Child \[Widget\] takes secondary color, only if \[showGradient\] is false. Default \[showGradient\] will be false. | + diff --git a/src/gf-sticky-header.md b/src/gf-sticky-header.md index f9c0953..c606fde 100644 --- a/src/gf-sticky-header.md +++ b/src/gf-sticky-header.md @@ -6,15 +6,15 @@ description: >- # GF Flutter Sticky Header -**GFStickyHeader** is a **Flutter Sticky Header** that will be fixed or sticks on the top of the screen like the header that has a scrollable container. +**GFStickyHeader** is a **Flutter Sticky Header** that will be fixed or sticks on the top of the screen like the header that has a scrollable container. -![Flutter Sticky Header ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Sticky_headers_docs_baner_compressed\_-\_a1zk2C7.gif) +![Flutter Sticky Header ](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Sticky_headers_docs_baner_compressed_-_a1zk2C7.gif) -### GF Flutter Sticky Header Example +#### GF Flutter Sticky Header Example -Always wrap **GFSticky Header** inside \[LIstView], \[GridView], \[CustomScrollView], \[SingleChildScrollView] or similar type of widget. +Always wrap **GFSticky Header** inside \[LIstView\], \[GridView\], \[CustomScrollView\], \[SingleChildScrollView\] or similar type of widget. -The example code of a basic **GF Flutter Sticky Header** is as shown below. +The example code of a basic **GF Flutter Sticky Header** is as shown below. ```dart List imageList = ['asset images here']; @@ -85,21 +85,21 @@ ListView.builder( )), ``` -## GF Flutter Sticky Header Types +### GF Flutter Sticky Header Types -### GF Flutter Sticky Header - Vertical +#### GF Flutter Sticky Header - Vertical -GF Sticky Header property_`direction: Axis.vertical`aligns the _**stickyContent** \__and content in vertical position. +GF Sticky Header property_`direction: Axis.vertical`_aligns the __**stickyContent** __and content in vertical position. -### GF Flutter Sticky Header - Horizontal +#### GF Flutter Sticky Header - Horizontal -GF Sticky Header property\_`direction: Axis.horizontal`\_aligns the **stickyContent** and content in horizontal position. +GF Sticky Header property_`direction: Axis.horizontal`_aligns the **stickyContent** and content in horizontal position. -## GF Flutter Sticky Header Builder +### GF Flutter Sticky Header Builder -\[GFStickyHeaderBuilder] component works the same as **GFStickyHeade**r, instead of stickyHeader widget here we use \[builder]. This allows the user to customize the stickyHeader. +\[GFStickyHeaderBuilder\] component works the same as **GFStickyHeade**r, instead of stickyHeader widget here we use \[builder\]. This allows the user to customize the stickyHeader. -The basic example code **GFSticky Header Builder** is as shown below. +The basic example code **GFSticky Header Builder** is as shown below. ```dart List imageList = ['asset images here']; @@ -254,16 +254,63 @@ ListView.builder( )), ``` -## **GF Flutter StickyHeader** Custom Properties +### **GF Flutter StickyHeader** Custom Properties The look and feel of the **GFStickyHeader** can be customized using the **GFStickyHeader** properties. -| Name | Description | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **stickyContent** | widget can be used to define \[stickyContent] | -| **content** | widget can be used to define \[content]. | -| **enableHeaderOverlap** |

On state true, the [stickyContent] will overlap the [content].

Only works when direction is [Axis.vertical]. Default set to false.

| -| **stickyContentPosition** |

[GFPosition] allows to [stickyContentPosition] to stick at top in [Axis.vertical] and stick at start in [Axis.horizontal]

Defaults to [GFPosition.start]

| -| **callback** | Allows to add custom stickyHeader stuck offset value | -| **direction** |

[direction] allows children to align in vertical / horizontal way

Defaults to [Axis.vertical]

| -| **stickyContentBuilder** | builder widget can be used to define \[stickyContentBuilder]. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
stickyContent + widget can be used to define [stickyContent]
content + widget can be used to define [content].
enableHeaderOverlap + +

On state true, the [stickyContent] will overlap the [content].

+

Only works when direction is [Axis.vertical]. Default set to false.

+
stickyContentPosition + +

[GFPosition] allows to [stickyContentPosition] to stick at top in [Axis.vertical] + and stick at start in [Axis.horizontal]

+

Defaults to [GFPosition.start]

+
callback + Allows to add custom stickyHeader stuck offset value
direction + +

[direction] allows children to align in vertical / horizontal way

+

Defaults to [Axis.vertical]

+
stickyContentBuilder + builder widget can be used to define [stickyContentBuilder].
+ diff --git a/src/gf-tab.md b/src/gf-tab.md index b36ef8d..4dc3ab9 100644 --- a/src/gf-tab.md +++ b/src/gf-tab.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter TabBar is a TabBarView that consists of a pageview that displays the currently selected tab. @@ -6,7 +7,7 @@ description: >- # GF Flutter TabBar -![GF Flutter TabBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Tabs-icon\_1\_F0aJurg9W.png) +![GF Flutter TabBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Tabs-icon_1_F0aJurg9W.png) ## **GF Flutter Tab** @@ -16,7 +17,7 @@ description: >- The **GFTabBar** is a component that contains a set of tab buttons. A tab bar must be provided **tabController** to communicate with each **tabBarView** Component. -![GF Flutter TabBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Bottom_labelled_tabs\_3x_Tj9Q0jtsE.png) +![GF Flutter TabBar](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Bottom_labelled_tabs_3x_Tj9Q0jtsE.png) **TabController** should be initialized, to communicate between **Tabbar** and **Tabbarview**. @@ -71,31 +72,31 @@ GFTabBar( The look and feel of the **GFTabBar** can be customized using the **GFTabBar** properties. -| Name | Description | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **length** | total number of tabs. Typically greater than one. Must match \[TabBar.tabs]'s and \[TabBarView.children]'s length | -| **tabBarHeight** | sets \[GFTabBar] height | -| **tabBarColor** | sets \[TabBar] color using GFColor or material color \[Color] | -| **tabs** | typically a list of two or more \[Tab] widgets. The length of this list must match the \[controller]'s \[TabController.length] and the length of the \[TabBarView.children] list | -| **controller** | controls widget's selection and animation state. Must provide \[TabController] | -| **indicatorColor** | color of the line that appears below the selected tab. If this parameter is null, then the value of the Theme's indicatorColor property is used. | -| **indicatorWeight** | thickness of the line that appears below the selected tab. The value of this parameter must be greater than zero and its default value is 2.0. | -| **indicatorPadding** | horizontal padding for the line that appears below the selected tab. | -| **indicator** | defines the appearance of the selected tab indicator. | -| **indicatorSize** | defines how the selected tab indicator's size is computed. | -| **labelColor** | color of selected tab labels. | -| **unselectedLabelColor** | color of unselected tab labels. | -| **labelStyle** | text style of the selected tab labels. | -| **unselectedLabelStyle** | text style of the unselected tab labels. | -| **labelPadding** | padding added to each of the tab labels. | -| **shape** | defines the shape of tabBar | -| **isScrollable** | If \[isScrollable] is true, then each tab is as wide as needed for its label and the entire \[TabBar] is scrollable. Otherwise each tab gets an equal share of the available space. | +| Name | Description | +| :--- | :--- | +| **length** | total number of tabs. Typically greater than one. Must match \[TabBar.tabs\]'s and \[TabBarView.children\]'s length | +| **tabBarHeight** | sets \[GFTabBar\] height | +| **tabBarColor** | sets \[TabBar\] color using GFColor or material color \[Color\] | +| **tabs** | typically a list of two or more \[Tab\] widgets. The length of this list must match the \[controller\]'s \[TabController.length\] and the length of the \[TabBarView.children\] list | +| **controller** | controls widget's selection and animation state. Must provide \[TabController\] | +| **indicatorColor** | color of the line that appears below the selected tab. If this parameter is null, then the value of the Theme's indicatorColor property is used. | +| **indicatorWeight** | thickness of the line that appears below the selected tab. The value of this parameter must be greater than zero and its default value is 2.0. | +| **indicatorPadding** | horizontal padding for the line that appears below the selected tab. | +| **indicator** | defines the appearance of the selected tab indicator. | +| **indicatorSize** | defines how the selected tab indicator's size is computed. | +| **labelColor** | color of selected tab labels. | +| **unselectedLabelColor** | color of unselected tab labels. | +| **labelStyle** | text style of the selected tab labels. | +| **unselectedLabelStyle** | text style of the unselected tab labels. | +| **labelPadding** | padding added to each of the tab labels. | +| **shape** | defines the shape of tabBar | +| **isScrollable** | If \[isScrollable\] is true, then each tab is as wide as needed for its label and the entire \[TabBar\] is scrollable. Otherwise each tab gets an equal share of the available space. | ## GF Flutter TabBar View A page view that displays the widget which corresponds to the currently selected tab. This widget is typically used in conjunction with a GFTabBar and must provide TabBarController. -The tab controller's \__`TabController.length` must equal the length of the children list and the length of the `TabBar.tabs` list. +The tab controller's __`TabController.length` must equal the length of the children list and the length of the `TabBar.tabs` list. ```dart import 'package:getwidget/getwidget.dart'; @@ -114,11 +115,11 @@ Look and feel of the GFTabBarVIew can be customized using the GFTabBarView prope ### Flutter TabBar Custom Properties -| Name | Description | -| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| **controller** | controls widget's selection and animation state. Must provide \[TabController] | -| **children** | one widget per tab. Its length must match the length of the \[GFTabBar.tabs] list, as well as the \[controller]'s \[TabController.length]. | -| **height** | GFTabBarView height can be fixed | +| Name | Description | +| :--- | :--- | +| **controller** | controls widget's selection and animation state. Must provide \[TabController\] | +| **children** | one widget per tab. Its length must match the length of the \[GFTabBar.tabs\] list, as well as the \[controller\]'s \[TabController.length\]. | +| **height** | GFTabBarView height can be fixed | ### GF Flutter Tab with TabBarView @@ -163,26 +164,26 @@ Look and feel of the GFTabs can be customized using the GFTabs properties. ### Flutter GFTab Custom Properties -| Name | Description | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **length** | total number of tabs. Typically greater than one. Must match \[TabBar.tabs]'s and \[TabBarView.children]'s length | -| **tabBarColor** | sets \[TabBar] color using GFColor or material color \[Color] | -| **tabs** | typically a list of two or more \[Tab] widgets. The length of this list must match the \[controller]'s \[TabController.length] and the length of the \[TabBarView.children] list | -| **controller** | controls widget's selection and animation state. Must provide \[TabController] | -| **indicatorColor** | color of the line that appears below the selected tab. If this parameter is null, then the value of the Theme's indicatorColor property is used. | -| **indicatorWeight** | thickness of the line that appears below the selected tab. The value of this parameter must be greater than zero and its default value is 2.0. | -| **indicatorPadding** | horizontal padding for the line that appears below the selected tab. | -| **indicator** | defines the appearance of the selected tab indicator. | -| **indicatorSize** | defines how the selected tab indicator's size is computed. | -| **labelColor** | color of selected tab labels. | -| **unselectedLabelColor** | color of unselected tab labels. | -| **labelStyle** | text style of the selected tab labels. | -| **unselectedLabelStyle** | text style of the unselected tab labels. | -| **labelPadding** | padding added to each of the tab labels. | -| **tabBarView** | one widget per tab. LIst of widgets given to TabBarView. The length of this list must match the \[controller]'s \[TabController.length] and the length of the \[TabBarView.children] list. | -| **tabBarHeight** | defines the tabBar height | -| **height** | defines the complete GFTabs height includes tabBar and tabBarView. | -| **shape** | defines the shape of tabBar | +| Name | Description | +| :--- | :--- | +| **length** | total number of tabs. Typically greater than one. Must match \[TabBar.tabs\]'s and \[TabBarView.children\]'s length | +| **tabBarColor** | sets \[TabBar\] color using GFColor or material color \[Color\] | +| **tabs** | typically a list of two or more \[Tab\] widgets. The length of this list must match the \[controller\]'s \[TabController.length\] and the length of the \[TabBarView.children\] list | +| **controller** | controls widget's selection and animation state. Must provide \[TabController\] | +| **indicatorColor** | color of the line that appears below the selected tab. If this parameter is null, then the value of the Theme's indicatorColor property is used. | +| **indicatorWeight** | thickness of the line that appears below the selected tab. The value of this parameter must be greater than zero and its default value is 2.0. | +| **indicatorPadding** | horizontal padding for the line that appears below the selected tab. | +| **indicator** | defines the appearance of the selected tab indicator. | +| **indicatorSize** | defines how the selected tab indicator's size is computed. | +| **labelColor** | color of selected tab labels. | +| **unselectedLabelColor** | color of unselected tab labels. | +| **labelStyle** | text style of the selected tab labels. | +| **unselectedLabelStyle** | text style of the unselected tab labels. | +| **labelPadding** | padding added to each of the tab labels. | +| **tabBarView** | one widget per tab. LIst of widgets given to TabBarView. The length of this list must match the \[controller\]'s \[TabController.length\] and the length of the \[TabBarView.children\] list. | +| **tabBarHeight** | defines the tabBar height | +| **height** | defines the complete GFTabs height includes tabBar and tabBarView. | +| **shape** | defines the shape of tabBar | ## GF Flutter Segment Tabs @@ -214,32 +215,32 @@ Look and feel of the GFSEgmentTabs can be customized using the GFSegmentTabs pro ### Flutter Segment Tabs Custom Properties -| Name | Description | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **length** | total number of tabs. Typically greater than one. Must match \[TabBar.tabs]'s and \[TabBarView.children]'s length | -| **height** | sets \[GFSegmentTabs] height | -| **tabBarColor** | sets \[TabBar] color using GFColor or material color \[Color] | -| **tabs** | typically a list of two or more \[Tab] widgets. The length of this list must match the \[controller]'s \[TabController.length] and the length of the \[TabBarView.children] list | -| **controller** | controls widget's selection and animation state. Must provide \[TabController] | -| **indicatorColor** | color of the line that appears below the selected tab. If this parameter is null, then the value of the Theme's indicatorColor property is used. | -| **indicatorWeight** | thickness of the line that appears below the selected tab. The value of this parameter must be greater than zero and its default value is 2.0. | -| **indicatorPadding** | horizontal padding for the line that appears below the selected tab. | -| **indicator** | defines the appearance of the selected tab indicator. | -| **indicatorSize** | defines how the selected tab indicator's size is computed. | -| **labelColor** | color of selected tab labels. | -| **unselectedLabelColor** | color of unselected tab labels. | -| **labelStyle** | text style of the selected tab labels. | -| **unselectedLabelStyle** | text style of the unselected tab labels. | -| **labelPadding** | padding added to each of the tab labels. | -| **border** | defines outer border of the tabs | -| **borderRadius** | defines outer border, border radius | -| **width** | defines width of the tab row | - -### GF Flutter Bottom Navigation TabBar - -GFTabBar can be used as a bottom navigation bar. - -The basic example code for a **bottom flutter tab bar** is given below. +| Name | Description | +| :--- | :--- | +| **length** | total number of tabs. Typically greater than one. Must match \[TabBar.tabs\]'s and \[TabBarView.children\]'s length | +| **height** | sets \[GFSegmentTabs\] height | +| **tabBarColor** | sets \[TabBar\] color using GFColor or material color \[Color\] | +| **tabs** | typically a list of two or more \[Tab\] widgets. The length of this list must match the \[controller\]'s \[TabController.length\] and the length of the \[TabBarView.children\] list | +| **controller** | controls widget's selection and animation state. Must provide \[TabController\] | +| **indicatorColor** | color of the line that appears below the selected tab. If this parameter is null, then the value of the Theme's indicatorColor property is used. | +| **indicatorWeight** | thickness of the line that appears below the selected tab. The value of this parameter must be greater than zero and its default value is 2.0. | +| **indicatorPadding** | horizontal padding for the line that appears below the selected tab. | +| **indicator** | defines the appearance of the selected tab indicator. | +| **indicatorSize** | defines how the selected tab indicator's size is computed. | +| **labelColor** | color of selected tab labels. | +| **unselectedLabelColor** | color of unselected tab labels. | +| **labelStyle** | text style of the selected tab labels. | +| **unselectedLabelStyle** | text style of the unselected tab labels. | +| **labelPadding** | padding added to each of the tab labels. | +| **border** | defines outer border of the tabs | +| **borderRadius** | defines outer border, border radius | +| **width** | defines width of the tab row | + +### GF Flutter Bottom Navigation TabBar + +GFTabBar can be used as a bottom navigation bar. + +The basic example code for a **bottom flutter tab bar** is given below. ```dart import 'package:getwidget/getwidget.dart'; @@ -279,3 +280,4 @@ Scaffold( ), ) ``` + diff --git a/src/gf-tile.md b/src/gf-tile.md index 8bad6a4..4fe25bb 100644 --- a/src/gf-tile.md +++ b/src/gf-tile.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- Gf Flutter ListTile represents a single row that typically contains some text as title, subtitle, icons as trailing, and additional text for description. @@ -10,7 +11,7 @@ description: >- **GFListTile** is a **Flutter ListTile** that is a widget used to populate a ListView in an application. It generally has a **title**, and one to three lines of **description or subtitle**, and a trailing **icon**. The **ListTile background color** can be changed using the color property. -## GF Flutter ListTile Example +## GF Flutter ListTile Example The simple **GF ListTile** code is as shown below @@ -24,11 +25,11 @@ GFListTile( ), ``` -### GF Flutter ListTile With Avatar +### GF Flutter ListTile With Avatar -**GFListTile** can have an **avatar** in the starting position in it. The avatar is usually a background image or just a profile image. +**GFListTile** can have an **avatar** in the starting position in it. The avatar is usually a background image or just a profile image. -The simple code of GF Flutter ListTile with the avatar is as shown below +The simple code of GF Flutter ListTile with the avatar is as shown below ```dart import 'package:getwidget/getwidget.dart'; @@ -45,23 +46,24 @@ GFListTile( **GF ListTile** has some of its custom properties to create a smooth look and feel for the application. The below table shows the custom properties: -| Name | Description | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **color** | The GFListTile's background color. Can be given \[Color] or \[GFColors] | -| **description** | The description to display inside the \[GFListTile]. see \[Text] | -| **padding** | defines the padding of GFListTile | -| **margin** | defines the margin of GFListTile | -| **titleText** | type of \[String] used to pass text, alternative to title property and gets higher priority than the title | -| **subTitleText** | type of \[String] used to pass text, alternative to subtitle property and gets higher priority than the subtitle | -| **avatar** | type of \[Widget] or \[GFAvatar] used to create a rounded user profile | -| **title** | The title to display inside the \[GFListTile]. see \[Text] | -| **subTitle** | The subtitle to display inside the \[GFListTile]. see \[Text] | -| **icon** | The icon to display inside the \[GFListTile]. see \[Icon] | -| **enabled** | Whether this list tile is interactive. If false, this list tile is styled with the disabled color from the current \[Theme] and the \[onTap] and \[onLongPress] callbacks are inoperative. | -| **onTap** | Called when the user taps this list tile. Inoperative if \[enabled] is false. | -| **onLongPress** | Called when the user long-presses on this list tile. Inoperative if \[enabled] is false. | -| **selected** | If this tile is also \[enabled] then icons and text are rendered with the same color. By default the selected color is the theme's primary color. The selected color can be overridden with a \[ListTileTheme]. | -| **focusColor** | The color for the tile's \[Material] when it has the input focus. | -| **hoverColor** | The color for the tile's \[Material] when a pointer is hovering over it. | -| **focusNode** | Defines the keyboard focus for this widget. | -| **autofocus** | On true state, it should focus itself if nothing else is already focused. Defaults to false | +| Name | Description | +| :--- | :--- | +| **color** | The GFListTile's background color. Can be given \[Color\] or \[GFColors\] | +| **description** | The description to display inside the \[GFListTile\]. see \[Text\] | +| **padding** | defines the padding of GFListTile | +| **margin** | defines the margin of GFListTile | +| **titleText** | type of \[String\] used to pass text, alternative to title property and gets higher priority than the title | +| **subTitleText** | type of \[String\] used to pass text, alternative to subtitle property and gets higher priority than the subtitle | +| **avatar** | type of \[Widget\] or \[GFAvatar\] used to create a rounded user profile | +| **title** | The title to display inside the \[GFListTile\]. see \[Text\] | +| **subTitle** | The subtitle to display inside the \[GFListTile\]. see \[Text\] | +| **icon** | The icon to display inside the \[GFListTile\]. see \[Icon\] | +| **enabled** | Whether this list tile is interactive. If false, this list tile is styled with the disabled color from the current \[Theme\] and the \[onTap\] and \[onLongPress\] callbacks are inoperative. | +| **onTap** | Called when the user taps this list tile. Inoperative if \[enabled\] is false. | +| **onLongPress** | Called when the user long-presses on this list tile. Inoperative if \[enabled\] is false. | +| **selected** | If this tile is also \[enabled\] then icons and text are rendered with the same color. By default the selected color is the theme's primary color. The selected color can be overridden with a \[ListTileTheme\]. | +| **focusColor** | The color for the tile's \[Material\] when it has the input focus. | +| **hoverColor** | The color for the tile's \[Material\] when a pointer is hovering over it. | +| **focusNode** | Defines the keyboard focus for this widget. | +| **autofocus** | On true state, it should focus itself if nothing else is already focused. Defaults to false | + diff --git a/src/gf-toast.md b/src/gf-toast.md index fb82943..30a8297 100644 --- a/src/gf-toast.md +++ b/src/gf-toast.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Toast is a Flutter Toast Widget that can be used to display quick warning or error messages for a short time period. You can customize it as @@ -9,7 +10,7 @@ description: >- ![GF Flutter Toast Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Toasts_CjkhzUIzm.png) -## GF Flutter Toast Widget and its Usage +### GF Flutter Toast Widget and its Usage **GFToast** is a **Flutter Toast** that is used to show **toast messages** or **errors** in a given interval of time and it can have trailing widgets to display icons or buttons. @@ -46,13 +47,13 @@ import 'package:getwidget/getwidget.dart'; )), ``` -## GF Flutter Toast with Trailing widget: +### GF Flutter Toast with Trailing widget: **GFToas**t can be used to dismiss or cancel messages or warnings with the help of a **GFButton** inside the GFToast. Hence GFToast will be usually accompanied by a **Flutter button**. The below example shows a simple code of how the **Flutter button** is used with the **GFToast**. -![Flutter Custom Toast with Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/BAsic_toasts\_3x_Jy51nVck_o.png) +![Flutter Custom Toast with Button](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/BAsic_toasts_3x_Jy51nVck_o.png) ```dart import 'package:getwidget/getwidget.dart'; @@ -91,7 +92,7 @@ import 'package:getwidget/getwidget.dart'; )), ``` -## GF Flutter Toast with custom Positioning +### GF Flutter Toast with custom Positioning Toasts can be positioned accordingly over viewing screen. The positioning can be done using `GFToastPosition.BOTTOM`. The usage of these is shown below. @@ -127,17 +128,18 @@ import 'package:getwidget/getwidget.dart'; )), ``` -## GF Flutter Toast Custom Properties +### GF Flutter Toast Custom Properties GFToast can be customized for a better look and feel. Here are the properties: -| Name | Description | -| --------------------- | ------------------------------------------------------ | -| **text** | text of type \[String] display on toast | -| **backgroundColor** | defines the background color of the toast | -| **textStyle** | defines the test style of the toast text | -| **toastBorderRadius** | defines the border radius of the toast | -| **border** | defines the border of the toast | -| **toastPosition** | defines the position of toast over the screen | -| **toastDuration** | defines the duration of time toast display over screen | -| **trailing** | defines the trailing widget of the toast | +| Name | Description | +| :--- | :--- | +| **text** | text of type \[String\] display on toast | +| **backgroundColor** | defines the background color of the toast | +| **textStyle** | defines the test style of the toast text | +| **toastBorderRadius** | defines the border radius of the toast | +| **border** | defines the border of the toast | +| **toastPosition** | defines the position of toast over the screen | +| **toastDuration** | defines the duration of time toast display over screen | +| **trailing** | defines the trailing widget of the toast | + diff --git a/src/gf-toggle.md b/src/gf-toggle.md index 36f3fcb..50efbbe 100644 --- a/src/gf-toggle.md +++ b/src/gf-toggle.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Toggle is a custom toggle widget like Square, Android, IOS, and Custom widget with many custom properties to customize as required. @@ -8,9 +9,9 @@ description: >- ![GF Flutter Toggle Widget](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/Toggles_hndeJnCfxa.png) -The **Flutter toggle switch** is **ON/OFF switch** or **ON/OFF Button** that allows the user to toggle the **switch** between **ON** or **OFF** states. +The **Flutter toggle switch** is **ON/OFF switch** or **ON/OFF Button** that allows the user to toggle the **switch** between **ON** or **OFF** states. -## GF Flutter Toggle and its Usage: +### GF Flutter Toggle and its Usage: **GFToggle** **switch** is a **Flutter Switch Toggle** that permits the user to use this toggle to mark check when it is in **ON** state and mark unchecked when it is in **OFF** state. The **toggle switch** basically switches from ON to OFF state and vice-versa. Let us look at a simple example of GFToggle in the below code. @@ -23,15 +24,15 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## GF Flutter Switch Toggle +### GF Flutter Switch Toggle -**GFToggle switch** can be divided into four types ie, `android`, `ios`, `square` and `custom`. The default toggle is an **android toggle.** +**GFToggle switch** can be divided into four types ie, `android`, `ios`, `square` and `custom`. The default toggle is an **android toggle.** -## Flutter IOS Toggle +### Flutter IOS Toggle **Flutter IOS Toggle** switch has a circular track and a circular thumb as shown in the below image. -![Flutter IOS Toggle](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/ios_bW24\_m8Gb_wJs\_-EKey0.webp) +![Flutter IOS Toggle](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/ios_bW24_m8Gb_wJs_-EKey0.webp) The below example code shows a simple ios toggle @@ -45,7 +46,7 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## Flutter Square Toggle +### Flutter Square Toggle **The Square Toggle** switch has a square-shaped track and a square-shaped thumb as shown in the below image. @@ -63,11 +64,11 @@ import 'package:getwidget/getwidget.dart'; ) ``` -## Flutter Custom Toggle +### Flutter Custom Toggle The **custom** **toggle** can be used to add the text to the on/off state. The default text is **ON** and **OFF** Below is a simple code for custom toggle -![Flutter Custom Toggle](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/custom-2\_IukUJZTss_ILY-qwiUmD.png) +![Flutter Custom Toggle](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/custom-2_IukUJZTss_ILY-qwiUmD.png) The below example code shows a simple custom toggle switch @@ -81,20 +82,21 @@ GFToggle( ), ``` -## GFToggle Custom Properties +### GFToggle Custom Properties The look and feel of **GFToggle** can be customized using the below properties -| Name | Description | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| **enabledText** | type of \[String] used to add custom text i.e, ON, ENABLE | -| **disabledText** | type of \[String] used to add custom text i.e, OFF, DISABLE | -| **enabledTextStyle** | type of \[TextStyle] used to define the style properties of enabled text | -| **disabledTextStyle** | type of \[TextStyle] used to define the style properties of disabled text | -| **enabledThumbColor** | color used for the active thumb color | -| **disabledThumbColor** | color used for the disabled thumb color | -| **enabledTrackColor** | color used for the active track color | -| **disabledTrackColor** | color used for the disabled track color | -| **boxShape** | type of \[BoxShape] ie , `circle`, `rectangle` used to change the shape of the thumb, default shape is `circle` | -| **borderRadius** | borderRadius should be given zero for a **ios** toggle to make it a **square** toggle with **boxshape** as `rectangle` | -| **duration** | animation duration called when the switch animates during the specific time elapse | +| Name | Description | +| :--- | :--- | +| **enabledText** | type of \[String\] used to add custom text i.e, ON, ENABLE | +| **disabledText** | type of \[String\] used to add custom text i.e, OFF, DISABLE | +| **enabledTextStyle** | type of \[TextStyle\] used to define the style properties of enabled text | +| **disabledTextStyle** | type of \[TextStyle\] used to define the style properties of disabled text | +| **enabledThumbColor** | color used for the active thumb color | +| **disabledThumbColor** | color used for the disabled thumb color | +| **enabledTrackColor** | color used for the active track color | +| **disabledTrackColor** | color used for the disabled track color | +| **boxShape** | type of \[BoxShape\] ie , `circle`, `rectangle` used to change the shape of the thumb, default shape is `circle` | +| **borderRadius** | borderRadius should be given zero for a **ios** toggle to make it a **square** toggle with **boxshape** as `rectangle` | +| **duration** | animation duration called when the switch animates during the specific time elapse | + diff --git a/src/gf-typography.md b/src/gf-typography.md index 0973fef..01c9237 100644 --- a/src/gf-typography.md +++ b/src/gf-typography.md @@ -1,4 +1,5 @@ --- +sidebarDepth: 2 description: >- GF Flutter Typography defines the different sizes of the texts in the application varying from Type 1 to Type 6. @@ -10,7 +11,7 @@ description: >- **Flutter Typography** is the art of arranging letters according to the need in order to make a clean styling of texts and words. -## GF Flutter Typography +### GF Flutter Typography **GFTypography** is a **Flutter Typography** that arranges the texts in a clean pattern with font-weight, the font size in order to give a stylish and smooth effect to the words. @@ -24,7 +25,7 @@ GFTypography( ), ``` -## GF Flutter Font Size +### GF Flutter Font Size **GFTypograhy** comes in different sizes that vary from **Typo1** to **Typo6. The below** code shows **Typo1** example. @@ -37,11 +38,11 @@ GFTypography( ), ``` -## GF Flutter Fonts With Icon +### GF Flutter Fonts With Icon GFTypography comes with different type and it can be used with any kind of **icon**. The usual usage can be a **GFAvatar** to show the image and the name as shown in the below example. -![GF Flutter Typography with Icon](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/with_icon\_3x_f-2jWZF\_2.png) +![GF Flutter Typography with Icon](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/with_icon_3x_f-2jWZF_2.png) ```dart import 'package:getwidget/getwidget.dart'; @@ -53,11 +54,11 @@ import 'package:getwidget/getwidget.dart'; ), ``` -## GF Flutter fonts on Background Image +### GF Flutter fonts on Background Image **GFTypography** can have a **background image** in it and the **text or icon with the text** on it. The background image gives a more specific feature to GFTypography. The below code shows the **GFTypography** on **BackgroundImage**. -![GF Flutter Font with Background Image](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/with_image\_3x_EMzRHJ-fi.png) +![GF Flutter Font with Background Image](https://ik.imagekit.io/ionicfirebaseapp/getwidget/docs/tr:w-800,f-auto/with_image_3x_EMzRHJ-fi.png) ```dart import 'package:getwidget/getwidget.dart'; @@ -70,17 +71,18 @@ GFTypography( ), ``` -## GFTypography Custom Properties +### GFTypography Custom Properties The look and feel can be customized using **GFTypography** properties. -| Name | Description | -| ------------------------------ | ----------------------------------------------------------------------- | -| **child** | child of type Widget alternative to text Key | -| **dividerColor** | defines the color of the divider | -| **textColor** | defines the color of the text | -| **dividerBorderRadius** | the border radius of the divider | -| **dividerAlignment** | the alignment of the divider to `start`, `center` or `end` | -| **showDivider** | bool value to hide or show divider , defaults to true | -| **dividerWidth** | the width of the divider | +| Name | Description | +| :--- | :--- | +| **child** | child of type Widget alternative to text Key | +| **dividerColor** | defines the color of the divider | +| **textColor** | defines the color of the text | +| **dividerBorderRadius** | the border radius of the divider | +| **dividerAlignment** | the alignment of the divider to `start`, `center` or `end` | +| **showDivider** | bool value to hide or show divider , defaults to true | +| **dividerWidth** | the width of the divider | | **backgroundImagecolorFilter** | colorFilter of background image only when background image is available | + diff --git a/src/index.md b/src/index.md index 63de232..11bffb9 100644 --- a/src/index.md +++ b/src/index.md @@ -21,3 +21,4 @@ We are launching our Beta Release in the beginning to develop, to test the libra We are committed to continuing this library development to make flutter app design & development less time consuming and with a small learning curve too. Your support and feedback help us to build the best Flutter Open-Source product. + diff --git a/src/introduction.md b/src/introduction.md index 0d22be1..dee4732 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -1,7 +1,12 @@ --- +sidebarDepth: '0' description: >- Get Widget is one of the largest Flutter open-source UI Kit libraries for mobile or web apps. It has more than 1000+ pre-built reusable widgets. +image: >- + https://image.ionicfirebaseapp.com/tr:dpr-auto,tr:w-auto/gw_banner_QysQrCk2J.png +canonicalUrl: https://docs.getwidget.dev/ + --- # Flutter GetWidget Docs @@ -21,3 +26,4 @@ We are launching our Beta Release in the beginning to develop, to test the libra We are committed to continuing this library development to make flutter app design & development less time consuming and with a small learning curve too. Your support and feedback help us to build the best Flutter Open-Source product. +