From f2cd3d2294551757b8df4db94154ea42c59a52e8 Mon Sep 17 00:00:00 2001 From: Alexandru Mariuti Date: Wed, 30 Oct 2024 10:26:54 +0000 Subject: [PATCH] docs: add packages section (#182) --- docs/astro.config.mjs | 1 + docs/src/content/docs/packages.md | 34 +++++++++++++++++++++++++++++++ lib/shadcn_ui.dart | 1 + 3 files changed, 36 insertions(+) create mode 100644 docs/src/content/docs/packages.md diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 1fb3811b..48c0dfa4 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -40,6 +40,7 @@ export default defineConfig({ collapsed: false, }, { label: 'Typography', link: 'typography' }, + { label: 'Packages', link: 'packages' }, { label: 'Components', autogenerate: { directory: 'Components' }, diff --git a/docs/src/content/docs/packages.md b/docs/src/content/docs/packages.md new file mode 100644 index 00000000..e152ba6f --- /dev/null +++ b/docs/src/content/docs/packages.md @@ -0,0 +1,34 @@ +--- +title: Packages +sidebar: + order: 3 +--- + +## Packages included in the library + +Flutter Shadcn UI consists of fantastic open-source libraries that are exported and you can use them without importing them into your project. + +### [flutter_animate](https://pub.dev/packages/flutter_animate) + +The flutter animate library is a very cool animations library extensively used in Shadcn UI Components. + +With flutter_animate animations can be easily customized from the user, because components will take a `List`. + +### [lucide_icons_flutter](https://pub.dev/packages/lucide_icons_flutter) + +A nice icon library that is used in Shadcn UI Components. +You can use Lucide icons with the `LucideIcons` class, for example `LucideIcons.activity`. + +You can browse all the icons [here](https://lucide.dev/icons/). + +### [two_dimensional_scrollables](https://pub.dev/packages/two_dimensional_scrollables) + +A nice raw table (very performant) implementation used by the [ShadTable](./components/table) component. + +### [intl](https://pub.dev/packages/intl) + +The intl package provides internationalization and localization facilities, including message translation. + +### [flutter_svg_plus](https://pub.dev/packages/flutter_svg_plus) + +Draw SVG images. Used by the [ShadImage](./components/image) component. diff --git a/lib/shadcn_ui.dart b/lib/shadcn_ui.dart index fe53ca49..134fa8a1 100644 --- a/lib/shadcn_ui.dart +++ b/lib/shadcn_ui.dart @@ -107,3 +107,4 @@ export 'package:flutter_animate/flutter_animate.dart' hide Effect; export 'package:lucide_icons_flutter/lucide_icons.dart'; export 'package:two_dimensional_scrollables/two_dimensional_scrollables.dart'; export 'package:intl/intl.dart'; +export 'package:flutter_svg_plus/flutter_svg.dart';