Git Product home page Git Product logo

dioxus-use-request's Introduction

Dioxus - Use Request Hook

Build Status Publish Status Language: Rust Crates.io Version

A small crate that adds a hook for simple GET requests and convienient macro to Dioxus.

Example

Function

Using the hook like this...

let dog = use_request(&cx, (breed,), format!("https://dog.ceo/api/breed/{breed}/images/random"));

cx.render(match dog {
    Success(val) => rsx!(img { src: "{val.message}"}}),
    Failure(err) => rsx!("Failed to load dog"),
    Loading => rsx!("Loading dog image!"),
})

...achieves the same as this snippet which uses the Use Future Hook:

let dog = use_future(&cx, (breed,), |(breed)| async move {
        reqwest::get(format!("https://dog.ceo/api/breed/{breed}/images/random"))
            .await
            .unwrap()
            .json::<RandomDog>()
            .await
    });
    
cx.render(match dog.value() {
    Some(Ok(val)) => rsx!(img { src: "{val.message}"}}),
    Some(Err(err)) => rsx!("Failed to load dog"),
    None => rsx!("Loading dog image!"),
})

Macro

For additional convienience, you can also enable the use_request! macro.

[dependencies]
dioxus-use-request = { version = "0.1.4", features = ["macro"] }

It automatically extract the hook's dependencies from the given URL string. Using the macro, the example from above looks like this:

// Macro automatically extracts dependencies in curly braces (e.g. {breed}) from the given string literal
let dog = use_request!(cx, "https://dog.ceo/api/breed/{breed}/images/random");

cx.render(match dog {
    Success(val) => rsx!(img { src: "{val.message}"}}),
    Failure(err) => rsx!("Failed to load dog"),
    Loading => rsx!("Loading dog image!"),
})

Installation

For instructions on getting started with Dioxus, please refer to their Getting Started Guide. To use this crate, simply add it as dependency in your Cargo.toml. Make sure to enable the "macro" feature if you want to use the use_request! macro:

[dependencies]
dioxus-use-request = { version = "0.1.4", features = ["macro"] }

Features

  • Implement hook
  • Convienent macro with dependency extraction
  • Return UseRequest handle to make request restartable
  • Implement .split() on UseRequest handle which returns value and restart closure

If you encounter a bug or have an idea for a feature, feel free to open an issue!

License

This code is dual-licensed and availabe under MIT-License or Apache 2.0-License depending on what suits your needs best.

Apache2.0-License

Copyright 2022 Antonius Naumann

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

MIT-License

MIT License

Copyright (c) 2022 Antonius Naumann

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

dioxus-use-request's People

Contributors

antoniusnaumann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.