From 4b2c0e96ca6c7f5f364280532128abd9f2120ad7 Mon Sep 17 00:00:00 2001 From: TheNoumanDev <76642732+TheNoumanDev@users.noreply.github.com> Date: Tue, 5 May 2026 03:40:50 +0500 Subject: [PATCH 1/2] updated docs for tabbar and listview --- content/widgets/listview.md | 107 ++++++++++++++++++++---------------- content/widgets/tabbar.md | 26 ++++----- 2 files changed, 72 insertions(+), 61 deletions(-) diff --git a/content/widgets/listview.md b/content/widgets/listview.md index f5162e1..c7d4518 100644 --- a/content/widgets/listview.md +++ b/content/widgets/listview.md @@ -6,17 +6,28 @@ The ListView Widget enables the rendering of lists with dynamic and scrollable c ## Properties -| Property | Type | Description | -| :---------------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| item-template | object | [See properties](#item-template) | -| children | array | List of widgets | -| onItemTap | action | Dispatch when an ListView item is selected/tapped.The event dispatches only when you tap on the item. The index of the item can be retrieved using 'selectedItemIndex'. You can access as this.selectedItemIndex. See example linked above| -| onItemTapHaptic | enum | The type of haptic to perform when item is pressed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate | -| selectedItemIndex | integer | Selecting a ListView item gives the index of selected item | -| onSwipeToRefresh | action | Enable swipe to refresh. This will trigger onRefresh action if enabled | -| nestedScroll | boolean | Enable ScrollView synchronization with ListView if enabled. | -| shrinkWrap | boolean | ListView will be scrollable even inside ScrollView but with it's own scrollController if enabled. | -| styles | object | [See properties](#styles) | +| Property | Type | Description | +| :------------------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| item-template | object | [See properties](#item-template) | +| children | array | List of widgets | +| onItemTap | action | Dispatch when an ListView item is selected/tapped.The event dispatches only when you tap on the item. The index of the item can be retrieved using 'selectedItemIndex'. You can access as this.selectedItemIndex. See example linked above | +| onItemTapHaptic | enum | The type of haptic to perform when item is pressed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate | +| selectedItemIndex | integer | Selecting a ListView item gives the index of selected item | +| onSwipeToRefresh | action | Enable swipe to refresh. This will trigger onRefresh action if enabled | +| nestedScroll | boolean | Enable ScrollView synchronization with ListView if enabled. | +| shrinkWrap | boolean | ListView will be scrollable even inside ScrollView but with it's own scrollController if enabled. | +| initialScrollOffset | number | Set the initial scroll position by pixel offset. | +| initialScrollIndex | integer | Set the initial scroll position by item index. | +| styles | object | [See properties](#styles) | + +## Methods + +| Method | Description | +| :--------------------- | :--------------------------------------------------------------------------------------------------------------- | +| scrollToOffset(offset) | Scroll to a specific pixel offset with animation. | +| scrollToTop() | Scroll to the top of the list with animation. | +| scrollToBottom() | Scroll to the bottom of the list with animation. | +| scrollToIndex(index) | Scroll to a specific item by its index with animation. The offset is estimated based on the average item height. | ### item-template @@ -28,40 +39,40 @@ The ListView Widget enables the rendering of lists with dynamic and scrollable c ### styles -| Property | Type | Description | -| :--------------------------- | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| expanded | boolean | If the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g stretch horizontally for parent of type Row) | -| showSeparator | boolean | Show a separator between the items (default is true). | -| separatorColor | integer or string | Set the color for the separator between items, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | -| separatorWidth | integer | The thickness of the separator between items | -| separatorPadding | string or integer | Padding with CSS-style value e.g. padding: 5 20 5 Default 0 0 0 | -| borderRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. | -| borderColor | integer or string | Sets the border color, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | -| borderWidth | integer | Thickness of the border. Minimum value should be 0. | -| shadowColor | integer or string | Sets the box shadow color starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | -| shadowOffset | array | The values in array define the horizontal and vertical offset of the shadow. Example: if the shadowOffset is set to [2, 4], the shadow will be offset by 2 pixels horizontally and 4 pixels vertically from its original position. | -| shadowRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. | -| shadowStyle | string | The blur style to apply on the shadow `normal`, `solid`, `outer`, `inner` | -| stackPositionTop | integer | The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children. | -| stackPositionBottom | integer | The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children. | -| stackPositionLeft | integer | The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children. | -| stackPositionRight | integer | The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children. | -| captureWebPointer | boolean | Applicable for Web only. When overlaying widgets on top of certain HTML container (e.g. Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget. | -| margin | string or integer | Margin with CSS-style notation | -| padding | string or integer | Padding with CSS-style value | -| width | integer | The width property determines the horizontal size of an element, allowing control over its width dimension within the layout. | -| height | integer | The height property determines the vertical size of an element, allowing control over its height dimension within the layout. | -| backgroundImage | object | Background image of the box. [see properties](#stylesbackgroundImage) | -| backgroundGradient | object | Background gradient of the box [see properties ](#stylesbackgroundGradient) | -| backgroundColor | integer or string | Background color of the box. which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | -| expanded | boolean | If the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g. stretch horizontally for parent of type Row) | -| visibilityTransitionDuration | number | Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible. | -| elevation | integer | The z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. Minimum value: 0, Maximum value: 24 | -| elevationShadowColor | integer or string | The shadow color for the elevation, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | -| elevationBorderRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. | -| alignment | string | The alignment of the widget relative to its parent. `topLeft`, `topCenter`, `topRight`, `centerLeft`, `center`, `centerRight`, `bottomLeft`, `bottomCenter`, `bottomRight` | -| visible | boolean | Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified. | -| opacity | double | Adjusts the opacity of the widget. Values range from 0 (fully transparent) to 1 (opaque). Default is `1`. | -| fontSize | integer | Sets the size of the text. | -| fontFamily | string or object | Set the font family applicable for all widgets inside this container, see the list of all available font families [here](https://github.com/material-foundation/flutter-packages/blob/main/packages/google_fonts/generator/families_supported). You can specify the fontFamily name directly or specify a different fontFamily for each language, see [Here](../translations.mdx#optionally-configure-different-fontfamily-for-each-language-your-app-supports). | -| gap | integer | The gap between the children in the main direction | +| Property | Type | Description | +| :--------------------------- | :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| expanded | boolean | If the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g stretch horizontally for parent of type Row) | +| showSeparator | boolean | Show a separator between the items (default is true). | +| separatorColor | integer or string | Set the color for the separator between items, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | +| separatorWidth | integer | The thickness of the separator between items | +| separatorPadding | string or integer | Padding with CSS-style value e.g. padding: 5 20 5 Default 0 0 0 | +| borderRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. | +| borderColor | integer or string | Sets the border color, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | +| borderWidth | integer | Thickness of the border. Minimum value should be 0. | +| shadowColor | integer or string | Sets the box shadow color starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | +| shadowOffset | array | The values in array define the horizontal and vertical offset of the shadow. Example: if the shadowOffset is set to [2, 4], the shadow will be offset by 2 pixels horizontally and 4 pixels vertically from its original position. | +| shadowRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. | +| shadowStyle | string | The blur style to apply on the shadow `normal`, `solid`, `outer`, `inner` | +| stackPositionTop | integer | The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children. | +| stackPositionBottom | integer | The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children. | +| stackPositionLeft | integer | The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children. | +| stackPositionRight | integer | The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children. | +| captureWebPointer | boolean | Applicable for Web only. When overlaying widgets on top of certain HTML container (e.g. Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget. | +| margin | string or integer | Margin with CSS-style notation | +| padding | string or integer | Padding with CSS-style value | +| width | integer | The width property determines the horizontal size of an element, allowing control over its width dimension within the layout. | +| height | integer | The height property determines the vertical size of an element, allowing control over its height dimension within the layout. | +| backgroundImage | object | Background image of the box. [see properties](#stylesbackgroundImage) | +| backgroundGradient | object | Background gradient of the box [see properties ](#stylesbackgroundGradient) | +| backgroundColor | integer or string | Background color of the box. which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | +| expanded | boolean | If the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g. stretch horizontally for parent of type Row) | +| visibilityTransitionDuration | number | Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible. | +| elevation | integer | The z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. Minimum value: 0, Maximum value: 24 | +| elevationShadowColor | integer or string | The shadow color for the elevation, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | +| elevationBorderRadius | string or integer | The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0. | +| alignment | string | The alignment of the widget relative to its parent. `topLeft`, `topCenter`, `topRight`, `centerLeft`, `center`, `centerRight`, `bottomLeft`, `bottomCenter`, `bottomRight` | +| visible | boolean | Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified. | +| opacity | double | Adjusts the opacity of the widget. Values range from 0 (fully transparent) to 1 (opaque). Default is `1`. | +| fontSize | integer | Sets the size of the text. | +| fontFamily | string or object | Set the font family applicable for all widgets inside this container, see the list of all available font families [here](https://github.com/material-foundation/flutter-packages/blob/main/packages/google_fonts/generator/families_supported). You can specify the fontFamily name directly or specify a different fontFamily for each language, see [Here](../translations.mdx#optionally-configure-different-fontfamily-for-each-language-your-app-supports). | +| gap | integer | The gap between the children in the main direction | diff --git a/content/widgets/tabbar.md b/content/widgets/tabbar.md index f27e551..b93ba43 100644 --- a/content/widgets/tabbar.md +++ b/content/widgets/tabbar.md @@ -6,20 +6,20 @@ The TabBar Widget enables the creation of tab bars, providing a convenient and v ## Properties -| Property | Type | Description | -| :------------ | :------ | :--------------------------------------- | -| styles | object | [See properties](#styles) | -| selectedIndex | integer | Selecting a Tab based on its index order | -| items | array | Define each of your Tab here | -| onTabSelection | action | The action that will be performed when a tab is pressed. | -| onTabSelectionHaptic | enum | The type of haptic to perform when a tab is pressed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate | +| Property | Type | Description | +| :------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------- | +| styles | object | [See properties](#styles) | +| selectedIndex | integer | Selecting a Tab based on its index order | +| items | array | Define each of your Tab here | +| onTabSelection | action | The action that will be performed when a tab is pressed. | +| onTabSelectionHaptic | enum | The type of haptic to perform when a tab is pressed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate | ### styles | Property | Type | Description | | :----------------- | :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | tabPosition | string | How to lay out the Tab labels | -| tabAlignment | enum | The TabBar alignments: `start`, `startOffset`, `fill`, `center`. | +| tabAlignment | enum | The TabBar alignments: `start`, `startOffset`, `fill`, `center`. | | tabPadding | string or integer | Padding for each tab labels with CSS-style value. Default: 0 30 0 0 (right padding only) | | tabFontSize | integer | Font size for the tab text | | tabFontWeight | string | Font weight for the tab text | @@ -29,8 +29,8 @@ The TabBar Widget enables the creation of tab bars, providing a convenient and v | indicatorColor | integer or string | The color of the selected tab's indicator, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | | indicatorThickness | integer | The thickness of the selected tab's indicator | | margin | string or integer | Margin with CSS-style notation e.g. margin: 5 20 5 | -| borderWidth | integer | The width of border of tabs in integer i.e, 10 . -| borderRadius | integer | The radius of border of tabs in integer like 10, it applies on all sides. -| borderColor | integer or string |The color of borders of the tabs, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`| - -| +| borderWidth | integer | The width of border of tabs in integer i.e, 10 . | +| borderRadius | integer | The radius of border of tabs in integer like 10, it applies on all sides. | +| borderColor | integer or string | The color of borders of the tabs, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange` | +| persistentTabBar | boolean | When true, the tab bar stays pinned at the top while only the tab content scrolls. Default: false | +| useIndexedTab | boolean | When true, enables lazy-loaded indexed tab building with caching. Tabs are built only when first accessed and cached for instant switching. Eliminates lag when switching between tabs with heavy content. Default: false | From 33090b09b85ee799554beb27b45decc3ca835d4f Mon Sep 17 00:00:00 2001 From: TheNoumanDev <76642732+TheNoumanDev@users.noreply.github.com> Date: Tue, 5 May 2026 03:51:42 +0500 Subject: [PATCH 2/2] fixed error issues --- content/actions/authenticate-by-biometric.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/content/actions/authenticate-by-biometric.md b/content/actions/authenticate-by-biometric.md index 65fb095..243cd83 100644 --- a/content/actions/authenticate-by-biometric.md +++ b/content/actions/authenticate-by-biometric.md @@ -1,10 +1,8 @@ -## authenticateByBiometric +# authenticateByBiometric -It helps to authenticate user based on biometrics such as face and fingerprint based on sensor available on user's device. +It helps to authenticate user based on biometrics such as face and fingerprint based on sensor available on user's device. - -> [Note] -> It only works in native devices which has biometric sensors. +> **Note:** It only works on native devices which have biometric sensors. ### Native Configuration