Skip to content
This repository was archived by the owner on Mar 11, 2024. It is now read-only.

README_FR.md

Latest commit

 

History

History
283 lines (227 loc) · 14.7 KB

README_FR.md

File metadata and controls

283 lines (227 loc) · 14.7 KB
Raw

Flukit (pré-alpha)

Flukit est un mini framework Flutter polyvalent et facile à utiliser, inspiré de Get, qui simplifie le développement d'applications. Avec Flukit, vous pouvez facilement gérer le routage, la thématisation et les utilitaires, ainsi que tirer parti de widgets et de raccourcis préconçus pour rationaliser vos projets Flutter.

:rocket : Introduction

Bienvenue sur Flukit, une boîte à outils puissante conçue pour simplifier le processus de développement d'applications pour les développeurs Flutter. Notre objectif est de fournir une solution efficace et rationalisée pour les tâches courantes de développement d'applications, y compris le routage, le thématisation, les utilitaires et les widgets.

Le développement d'applications peut être complexe et prendre du temps, et notre framework est là pour vous faciliter la vie. Ce mini framework a pour but de rendre les développeurs autonomes en leur offrant un ensemble d'outils qui améliorent la productivité et fournissent une meilleure expérience de développement.

Que vous construisiez un petit projet ou une application complexe, ce mini framework Flutter est là pour vous aider à atteindre vos objectifs plus rapidement et avec moins d'efforts.

:sparkles : Caractéristiques

  • Widgets pré-conçus comme des boutons, des avatars, des écrans, des images, etc.
  • Routage : Il suffit de définir un certain nombre de pages et le tour est joué.
  • Thématisation : Personnalisez l'apparence de votre application sans effort grâce à un système de thématisation flexible qui vous permet de créer des designs uniques.
  • Utilitaires : Accédez à un ensemble de fonctions utilitaires pratiques qui simplifient les tâches de développement courantes.
  • Raccourcis : Gagnez du temps et réduisez les codes répétitifs grâce à des raccourcis et des extraits de code prédéfinis pour les tâches courantes.

:construction : Pour commencer

Pour utiliser flukit dans votre projet Flutter, ajoutez la dépendance suivante à votre pubspec.yaml :

dependencies:
  flukit:
    git:
      url: https://github.com/charles9904/flukit

Ensuite, lancez bash flutter packages get dans votre terminal pour installer le paquet.

:fire : Utilisation

Pour utiliser Flukit dans votre projet, importez le paquet et utilisez l'un des widgets ou utilitaires fournis. Par exemple, pour utiliser le widget flukit Button :

FluButton(
  onPressed: () {
    // Handle button press.
  },
  text: 'Press me',
),

Veuillez consulter la documentation (bientôt disponible) pour plus d'informations et d'exemples.

🔗 Widgets

📱 Ecrans

🔧 Services

💡 Utilitaires

  • [BuildContext] extensions

    • context.mediaQuerySize: equivalent of MediaQuery.of(context).size
    • context.height: equivalent of MediaQuery.of(context).size.height
    • context.width: equivalent of MediaQuery.of(context).size.width
    • context.heightTransformer: Gives you the power to get a portion of the screen height.
    • context.widthTransformer: Gives you the power to get a portion of the screen width.
    • context.ratio: Divide the height proportionally by the given value.
    • context.theme: similar to [Theme.of(context)]
    • context.colorScheme: similar to [Theme.of(context).colorScheme]
    • context.textTheme: similar to [Theme.of(context).textTheme]
    • context.isDarkMode: Check if dark mode theme is enabled
    • context.iconColor: give access to [Theme.of(context).iconTheme.color]
    • context.systemUiOverlayStyle: Set a [SystemUiOverlayStyle] based on the provided [ThemeData]
    • context.mediaQuery: similar to [MediaQuery.of(context)]
    • context.mediaQueryPadding: similar to [MediaQuery.of(context).padding]
    • context.mediaQueryViewPadding: similar to [MediaQuery.of(context).viewPadding]
    • context.mediaQueryViewInsets: similar to [MediaQuery.of(context).viewInsets]
    • context.orientation: similar to [MediaQuery.of(context).orientation]
    • context.statusBarHeight: return [MediaQuery.of(context).padding.top]
    • context.isKeyboardHidden: Check if the keyboard is visible or not
    • context.alwaysUse24HourFormat: similar to [MediaQuery.of(context).alwaysUse24HourFormat]
    • context.isLandscape: check if device is on landscape mode
    • context.isPortrait: check if device is on portrait mode
    • context.devicePixelRatio: similar to [MediaQuery.of(this).devicePixelRatio]
    • context.textScaleFactor: similar to [MediaQuery.of(this).textScaleFactor]
    • context.mediaQueryShortestSide: get the shortestSide from screen
    • context.showNavbar: True if width be larger than 800
    • context.isPhoneOrLess: True if the width is smaller than 600p
    • context.isPhoneOrWider: True if the width is higher than 600p
    • context.isPhone: True if the shortestSide is smaller than 600p
    • context.isSmallTabletOrLess: True if the width is smaller than 600p
    • context.isSmallTabletOrWider: True if the width is higher than 600p
    • context.isSmallTablet: True if the shortestSide is largest than 600p
    • context.isLargeTablet: True if the shortestSide is largest than 720p
    • context.isLargeTabletOrLess: True if the width is smaller than 720p
    • context.isLargeTabletOrWider: True if the width is higher than 720p
    • context.isTablet: True if the current device is Tablet
    • context.isDesktopOrLess: True if the width is smaller than 1200p
    • context.isDesktopOrWider: True if the width is higher than 1200p
    • context.isDesktop: same as [isDesktopOrLess]

  • [num] extensions

    • [num].isLowerThan
    • [num].isGreaterThan
    • [num].isEqual
    • [num].toPositive
    • [num].isLowerThan
    • [num].delay: Utility to delay some callback. Read more

  • [double] or [int] extensions

    • [double / int].milliseconds or double.ms: double to milliseconds [Duration]
    • [double / int].seconds: double to seconds [Duration]
    • [double / int].minutes: double to minutes [Duration]
    • [double / int].hours: double to hours [Duration]
    • [double / int].days: double to days [Duration]

  • [Durations] extensions

    • [Duration].delay: Utility to delay some callback. Read more

  • [List] extensions

    • [List].addIf: Add element to list if condition is respected

  • [String] extensions

    • [String].isNum: Discover if the String is a valid number
    • [String].isNumericOnly: Discover if the String is numeric only
    • [String].isAlphabetOnly: Discover if the String is alphanumeric only
    • [String].isBool: Discover if the String is a boolean
    • [String].isVectorFileName: Discover if the String is a vector
    • [String].isImageFileName: Discover if the String is a ImageFileName
    • [String].isAudioFileName: Discover if the String is a AudioFileName
    • [String].isVideoFileName: Discover if the String is a VideoFileName
    • [String].isTxtFileName: Discover if the String is a TxtFileName
    • [String].isDocumentFileName: Discover if the String is a Document Word
    • [String].isExcelFileName: Discover if the String is a Document Excel
    • [String].isPPTFileName: Discover if the String is a Document Powerpoint
    • [String].isAPKFileName: Discover if the String is a APK File
    • [String].isPDFFileName: Discover if the String is a PDF file
    • [String].isHTMLFileName: Discover if the String is a HTML file
    • [String].isURL: Discover if the String is a URL file
    • [String].isEmail: Discover if the String is a Email
    • [String].isPhoneNumber: Discover if the String is a Phone Number
    • [String].isDateTime: Discover if the String is a DateTime
    • [String].isMD5: Discover if the String is a MD5 Hash
    • [String].isSHA1: Discover if the String is a SHA1 Hash
    • [String].isSHA256: Discover if the String is a SHA256 Hash
    • [String].isBinary: Discover if the String is a bynary value
    • [String].isIPv4: Discover if the String is a ipv4
    • [String].isIPv6: Discover if the String is a ipv6
    • [String].isHexadecimal: Discover if the String is a Hexadecimal
    • [String].isPalindrom: Discover if the String is a palindrom
    • [String].isPassport: Discover if the String is a passport number
    • [String].isCurrency: Discover if the String is a currency
    • [String].isCpf: Discover if the String is a CPF number
    • [String].isCnpj: Discover if the String is a CNPJ number
    • [String].isCaseInsensitiveContains: Discover if the String is a case insensitive
    • [String].isCaseInsensitiveContainsAny: Discover if the String is a case sensitive and contains any value
    • [String].capitalize: capitalize the String
    • [String].capitalizeFirst: Capitalize the first letter of the String
    • [String].removeAllWhitespace: remove all whitespace from the String
    • [String].camelCase: converter the String
    • [String].paramCase: Discover if the String is a valid URL
    • [String].createPath: add segments to the String
    • [String].capitalizeAllWordsFirstLetter: capitalize only first letter in String words to upper case

  • Platform

    • Flu.isWeb
    • Flu.isMacOS
    • Flu.isWindows
    • Flu.isLinux
    • Flu.isAndroid
    • Flu.isIOS
    • Flu.isFuchsia
    • Flu.isMobile
    • Flu.isDesktop

  • Connectivity (pre-alpha)

    • Flu.deviceIsOnline
    • Flu.getDeviceConnectivity
    • Flu.listenToDeviceConnectivityChange

  • Trigger haptic

    • Flu.triggerSelectionClickHaptic
    • Flu.triggerVibrationHaptic
    • Flu.triggerLightImpactHaptic
    • Flu.triggerMediumImpactHaptic
    • Flu.triggerHeavyImpactHaptic

  • Validators

    • Flu.validatePhoneNumber
    • Flu.validateEmail

  • Parsers

    • Flu.dataFromBase64String: Decodes [base64] or [base64url] encoded bytes.

  • Helpers

    • M3FontSizes: Material design 3 recommended font sizes.
    • Countries: List of countries. Read more
    • Flu.numberToCompactFormat: A number format for compact representations, e.g. "1.2M" instead of "1,200,000".
    • Flu.textToAvatarFormat
    • Flu.hideKeyboard
    • Flu.showKeyboard
    • Flu.getAvatar
    • Flu.showFluModalBottomSheet
    • Flu.showCountrySelector

  • Date time

    • Flu.dateTimeFromTimestamp: Get DateTime from timestamp
    • Flu.timeFromDateTime: Get only the time from a datetime.
    • Flu.formatDate: Creates a new DateFormat, using the format specified by [pattern]
    • Flu.timeago: Formats provided [date] to a fuzzy time like 'a moment ago'
    • Flu.timeFromSeconds: Get time from seconds
    • Flu.timeLeft
    • Flu.formatDuration

  • Navigation

    • to: Pushes a new page to the stack
    • toNamed: Pushes a new named page to the stack.
    • offNamed: Pop the current named page in the stack and push a new one in its place
    • until: Calls pop several times in the stack until [predicate] returns true
    • offUntil: Push the given page, and then pop several pages in the stack until [predicate] returns true
    • offNamedUntil: Push the given named page, and then pop several pages in the stack until [predicate] returns true
    • offAndToNamed: Pop the current named page and pushes a new page to the stack in its place
    • removeRoute: Remove a specific [route] from the stack
    • offAllNamed: Push a named page and pop several pages in the stack until [predicate] returns true. [predicate] is optional
    • back: Pop the current page, snackbar, dialog or bottomsheet in the stack
    • close: Close as many routes as defined by [times]
    • off: Pop the current page and pushes a new page to the stack
    • offAll: Push a page and pop several pages in the stack until [predicate] returns true. [predicate] is optional
    • cleanRouteName: Takes a route name String generated, cleans the extra chars and accommodates the format. Eg: () => MyHomeScreenView becomes /my-home-screen-view.
    • focusScope: give access to FocusScope.of(context)

:v : Contribuer

Les contributions à Flukit sont les bienvenues et encouragées ! Pour contribuer, veuillez forker le dépôt et soumettre une demande d'extraction. Assurez-vous de lire le [Guide de contribution] (https://github.com/charles9904/flukit/blob/main/CONTRIBUTING.md) avant de faire une demande de téléchargement.

  • Ce qu'il faut faire :

    • Rédiger une documentation
    • Rédiger et mettre en place des tests
    • Optimiser le code
    • Ajouter plus de widgets et d'utilitaires

:page_with_curl : Licence

Flukit est sous licence MIT