https://github.com/lenra-io/client-lib-flutter

A lib to let you create your Flutter application with Lenra backend
https://github.com/lenra-io/client-lib-flutter

client dart flutter lenra lib

Last synced: about 2 months ago
JSON representation

A lib to let you create your Flutter application with Lenra backend

• Host: GitHub
• URL: https://github.com/lenra-io/client-lib-flutter
• Owner: lenra-io
• License: mit
• Created: 2023-08-08T17:04:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-05T12:58:47.000Z (7 months ago)
• Last Synced: 2024-06-05T14:44:15.777Z (7 months ago)
• Topics: client, dart, flutter, lenra, lib
• Language: C++
• Homepage:
• Size: 332 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






Lenra's Flutter client lib


  


    Let you create your Flutter application with Lenra backend.

    


    


    Report Bug

    ·

    Request Feature

  



## Prerequisites

Add the dependency to your project:

```console

flutter pub add lenra_client

```

You might need some other prerequisites since this lib is still in using [flutter_secure_storage](https://pub.dev/packages/flutter_secure_storage).

Look at this lib documentation to see what you need.

(back to top)


## Usage

Add a `LenraApplication` to your app:

```dart

import 'package:flutter/material.dart';

import 'package:lenra_client/widgets.dart';

void main() {

  runApp(const MyApp());

}

class MyApp extends StatelessWidget {

  const MyApp({super.key});

  // This widget is the root of your application.

  @override

  Widget build(BuildContext context) {

    return MaterialApp(

      title: 'Flutter Demo',

      theme: ThemeData(

        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),

        useMaterial3: true,

      ),

      home: LenraApplication(

        // set your own client id for production

        clientId: 'XXX-XXX-XXX',

        child: const MyHomePage(title: 'Flutter Demo Home Page'),

      ),

    );

  }

}

```

This while automatically start the authentication flow.

You can then add `LenraView` instances to your widget tree to link the widget to a Lenra view and use it data:

```dart

class MyHomePage extends StatelessWidget {

  const MyHomePage({super.key, required this.title});

  final String title;

  @override

  Widget build(BuildContext context) {

    return LenraView(

      route: "/counter/me",

      builder: (

        BuildContext context,

        Map json,

        ListenerCaller callListener,

      ) =>

          Scaffold(

        appBar: AppBar(

          backgroundColor: Theme.of(context).colorScheme.inversePrimary,

          title: Text(title),

        ),

        body: Center(

          child: Column(

            mainAxisAlignment: MainAxisAlignment.center,

            children: [

              const Text(

                'You have pushed the button this many times:',

              ),

              Text(

                '${json["value"]}',

                style: Theme.of(context).textTheme.headlineMedium,

              ),

            ],

          ),

        ),

        floatingActionButton: FloatingActionButton(

          onPressed: () => callListener(json["onIncrement"]),

          tooltip: 'Increment',

          child: const Icon(Icons.add),

        ), // This trailing comma makes auto-formatting nicer for build methods.

      ),

      loader: const CircularProgressIndicator(),

    );

  }

}

```

For the web target, you also have to add the following JavaScript to a redirect file (default to `redirect.html`) to handle OAuth2 redirection (see the [example](./example/web/redirect.html)):

```javascript

window.onload = function() {

  window.opener.postMessage(window.location.href, `${window.location.protocol}//${window.location.host}`);

}

```

(back to top)


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement".

Don't forget to give the project a star if you liked it! Thanks again!

(back to top)


## License

Distributed under the **MIT** License. See [LICENSE](./LICENSE) for more information.

(back to top)


## Contact

Lenra - [@lenra_dev](https://twitter.com/lenra_dev) - [email protected]

Project Link: [https://github.com/lenra-io/client-lib-flutter](https://github.com/lenra-io/client-lib-flutter)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/lenra-io/client-lib-flutter.svg?style=for-the-badge

[contributors-url]: https://github.com/lenra-io/client-lib-flutter/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/lenra-io/client-lib-flutter.svg?style=for-the-badge

[forks-url]: https://github.com/lenra-io/client-lib-flutter/network/members

[stars-shield]: https://img.shields.io/github/stars/lenra-io/client-lib-flutter.svg?style=for-the-badge

[stars-url]: https://github.com/lenra-io/client-lib-flutter/stargazers

[issues-shield]: https://img.shields.io/github/issues/lenra-io/client-lib-flutter.svg?style=for-the-badge

[issues-url]: https://github.com/lenra-io/client-lib-flutter/issues

[license-shield]: https://img.shields.io/github/license/lenra-io/client-lib-flutter.svg?style=for-the-badge

[license-url]: https://github.com/lenra-io/client-lib-flutter/blob/master/LICENSE