internal/flutter_timeline
5
0
Fork 0
mirror of https://github.com/Iconica-Development/flutter_timeline.git synced 2025-05-19 10:33:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: make readme up to date

Browse source
This commit is contained in:
Vick Top 2024-03-25 14:29:56 +01:00
parent 1ce80135f5
commit 8eaf40b0c0
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -126,6 +126,9 @@ TimelinePostCreationScreen(
), ),
``` ```
You can choose to show an overview of the post before actually posting it using the `enablePostOverviewScreen` config setting.
The `TimelineOptions` has its own parameters, as specified below: The `TimelineOptions` has its own parameters, as specified below:
| Parameter | Explanation | | Parameter | Explanation |
@ -136,11 +139,17 @@ The `TimelineOptions` has its own parameters, as specified below:
| imagePickerTheme | Theme for the image picker in the post creation screen. | | imagePickerTheme | Theme for the image picker in the post creation screen. |
| timelinePostHeight | Sets the height for each post widget in the list of post. If null, the size depends on the size of the image. | | timelinePostHeight | Sets the height for each post widget in the list of post. If null, the size depends on the size of the image. |
| allowAllDeletion | Determines of users are allowed to delete thier own posts. | | allowAllDeletion | Determines of users are allowed to delete thier own posts. |
| afterPostCreationGoHome | Boolean to enable redirect to home after post creation. If false, it will redirect to created post screen. |
| enablePostOverviewScreen | Boolean to enable timeline post overview screen before submitting. |
| sortCommentsAscending | Determines if the comments are sorted from old to new or new to old. | | sortCommentsAscending | Determines if the comments are sorted from old to new or new to old. |
| sortPostsAscending | Determines if the posts are sorted from old to new or new to old. | | sortPostsAscending | Determines if the posts are sorted from old to new or new to old. |
| doubleTapToLike | Enables the abilty to double tap the image to like the post. | | doubleTapToLike | Enables the abilty to double tap the image to like the post. |
| iconsWithValues | Ability to provide desired text and tanslations. | | iconsWithValues | Ability to provide desired text and tanslations. |
| likeAndDislikeIconsForDoubleTap | Ability to override the standard icon which appears on double tap. | | likeAndDislikeIconsForDoubleTap | Ability to override the standard icon which appears on double tap. |
| homeOpenPageBuilder | Open page builder function for the home page. |
| postCreationOpenPageBuilder | Open page builder function for the post creation page. |
| postViewOpenPageBuilder | Open page builder function for the post view page. |
| postOverviewOpenPageBuilder | Open page builder function for the post overview page. |
| itemInfoBuilder | Ability to override the bottom of the postwidgets. (Everything under the like and comment icons) | | itemInfoBuilder | Ability to override the bottom of the postwidgets. (Everything under the like and comment icons) |
| dateFormat | Sets the used date format | | dateFormat | Sets the used date format |
| timeFormat | Sets the used time format | | timeFormat | Sets the used time format |
@ -153,6 +162,10 @@ The `TimelineOptions` has its own parameters, as specified below:
| padding | Padding used for the whole page. | | padding | Padding used for the whole page. |
| iconSize | Size of icons like the comment and like icons. Dafualts to 26. | | iconSize | Size of icons like the comment and like icons. Dafualts to 26. |
| postWidgetHeight | Ability to provide desired text and tanslations. | | postWidgetHeight | Ability to provide desired text and tanslations. |
| minTitleLength | Minimum length of the title. |
| maxTitleLength | Maximum length of the title. |
| minContentLength | Minimum length of the post content. |
| maxContentLength | Maximum length of the post content. |
| postPadding | Padding for each post. | | postPadding | Padding for each post. |
| filterOptions | Options for using the filter to filter posts. | | filterOptions | Options for using the filter to filter posts. |
| categoriesOptions | Options for using the category selector to provide posts of a certain category. | | categoriesOptions | Options for using the category selector to provide posts of a certain category. |