Skip to content

feat(indexes): add builderSliverContent for lazy loading (fixes #687) #913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Luozf12345 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

feat(indexes): add builderSliverContent for lazy loading (fixes #687) #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81843b4
feat(indexes): add builderSliverContent for lazy loading with large d…
Luozf12345 Apr 11, 2026
11542c5
[autofix.ci] apply automated fixes
autofix-ci[bot] Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions tdesign-component/example/assets/api/indexes_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
| builderAnchor | Widget? Function(BuildContext context, String index, bool isPinnedToTop)? | - | 锚点自定义构建 |
| builderContent | Widget? Function(BuildContext context, String index) | - | 内容自定义构建 |
| builderIndex | Widget Function(BuildContext context, String index, bool isActive)? | - | 索引文本自定义构建，包括索引激活左侧提示 |
| builderSliverContent | Widget? Function(BuildContext context, String index)? | - | 内容自定义Sliver构建，用于大数据量场景实现懒加载，性能优于builderContent。 |
| capsuleTheme | bool? | false | 锚点是否为胶囊式样式 |
| indexList | List<String>? | - | 索引字符列表。不传默认 A-Z |
| indexListMaxHeight | double? | 0.8 | 索引列表最大高度（父容器高度的百分比，默认 0.8） |
Expand Down
46 changes: 33 additions & 13 deletions tdesign-component/lib/src/components/indexes/t_indexes.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class TIndexes extends StatefulWidget {
this.onChange,
this.onSelect,
required this.builderContent,
this.builderSliverContent,
this.builderAnchor,
this.builderIndex,
}) : super(key: key);
Expand Down Expand Up @@ -57,6 +58,11 @@ class TIndexes extends StatefulWidget {
/// 内容自定义构建
final Widget? Function(BuildContext context, String index) builderContent;

/// 内容自定义Sliver构建，用于大数据量场景实现懒加载，性能优于builderContent。
/// 返回Sliver类型Widget（如SliverList.builder），优先级高于builderContent。
final Widget? Function(BuildContext context, String index)?
builderSliverContent;

/// 锚点自定义构建
final Widget? Function(
BuildContext context, String index, bool isPinnedToTop)? builderAnchor;
Expand Down Expand Up @@ -144,6 +150,32 @@ class _TIndexesState extends State<TIndexes> {
_contentKeys.clear();
return _indexList.map((e) {
final isPinnedOffset = capsuleTheme && _activeIndex.value == e;

Widget contentSliver;
if (widget.builderSliverContent != null) {
contentSliver = Builder(
builder: (context) {
_contentKeys[e] = context;
return widget.builderSliverContent!(context, e) ??
const SliverToBoxAdapter(child: SizedBox.shrink());
},
);
} else {
contentSliver = SliverToBoxAdapter(
child: Builder(
builder: (context) {
_contentKeys[e] = context;
return Padding(
padding: isPinnedOffset
? EdgeInsets.only(top: TTheme.of(context).spacer8)
: EdgeInsets.zero,
child: widget.builderContent(context, e),
);
},
),
);
}

return SliverStickyHeader.builder(
sticky: widget.sticky ?? true,
pinnedOffset: isPinnedOffset
Expand All @@ -165,19 +197,7 @@ class _TIndexesState extends State<TIndexes> {
sticky: widget.sticky ?? true,
);
},
sliver: SliverToBoxAdapter(
child: Builder(
builder: (context) {
_contentKeys[e] = context;
return Padding(
padding: isPinnedOffset
? EdgeInsets.only(top: TTheme.of(context).spacer8)
: EdgeInsets.zero,
child: widget.builderContent(context, e),
);
},
),
),
sliver: contentSliver,
);
}).toList();
}
Expand Down
1 change: 1 addition & 0 deletions tdesign-site/src/indexes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ Widget _buildOther(BuildContext context) {
| builderAnchor | Widget? Function(BuildContext context, String index, bool isPinnedToTop)? | - | 锚点自定义构建 |
| builderContent | Widget? Function(BuildContext context, String index) | - | 内容自定义构建 |
| builderIndex | Widget Function(BuildContext context, String index, bool isActive)? | - | 索引文本自定义构建，包括索引激活左侧提示 |
| builderSliverContent | Widget? Function(BuildContext context, String index)? | - | 内容自定义Sliver构建，用于大数据量场景实现懒加载，性能优于builderContent。 |
| capsuleTheme | bool? | false | 锚点是否为胶囊式样式 |
| indexList | List<String>? | - | 索引字符列表。不传默认 A-Z |
| indexListMaxHeight | double? | 0.8 | 索引列表最大高度（父容器高度的百分比，默认 0.8） |
Expand Down
Loading