Crate pagetop

PageTop

An opinionated web framework to build modular Server-Side Rendering web solutions.

The PageTop core API provides a comprehensive toolkit for extending its functionalities to specific requirements and application scenarios through actions, components, packages, and themes:

• Actions serve as a mechanism to customize PageTop’s internal behavior by intercepting its execution flow.
• Components encapsulate HTML, CSS, and JavaScript into functional, configurable, and well-defined units.
• Packages extend or customize existing functionality by interacting with PageTop APIs or third-party package APIs.
• Themes enable developers to alter the appearance of pages and components without affecting their functionality.

⚡️ Quick start

use pagetop::prelude::*;

struct HelloWorld;

impl PackageTrait for HelloWorld {
    fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
        scfg.route("/", service::web::get().to(hello_world));
    }
}

async fn hello_world(request: HttpRequest) -> ResultPage<Markup, ErrorPage> {
    Page::new(request)
        .with_component(Html::with(html! { h1 { "Hello World!" } }))
        .render()
}

#[pagetop::main]
async fn main() -> std::io::Result<()> {
    Application::prepare(&HelloWorld).run()?.await
}

This program implements a package named HelloWorld with one service that returns a web page that greets the world whenever it is accessed from the browser at http://localhost:8088 (using the default configuration settings). You can find this code in the PageTop examples repository.

🧩 Dependency Management

Projects leveraging PageTop will use cargo to resolve dependencies, similar to any other Rust project.

Nevertheless, it’s crucial that each package explicitly declares its dependencies, if any, to assist PageTop in structuring and initializing the application in a modular fashion.

🚧 Warning

PageTop framework is currently in active development. The API is unstable and subject to frequent changes. Production use is not recommended until version 0.1.0.

Modules

• app
  Prepare and run an application created with Pagetop.
• base
  Base actions, components, packages, and themes.
• config
  Retrieve and apply settings values from configuration files.
• core
  Key types and functions for creating actions, components, packages, and themes.
• datetime
  ISO 8601 date and time handling (chrono).
• dbdatabase
  Database access.
• html
  HTML in code.
• locale
  Localization (L10n).
• prelude
  The PageTop Prelude.
• response
  Web request response variants.
• service
  Essential web framework (actix-web).
• trace
  Application tracing and event logging.
• util
  Functions and macro helpers.

Macros

• actions
• concat_string
  Concatenates a series of string slices into an owned string.
• default_settings
  Define un conjunto de ajustes de configuración usando tipos seguros y valores predefinidos.
• kv
  Macro para construir grupos de pares clave-valor.
• migrationsdatabase
• paste
  Enables flexible identifier concatenation in macros, allowing new items with pasted identifiers.
• service_for_static_files
• static_files
• static_locales
  Defines a set of localization elements and local translation texts.

Structs

• LazyStatic
  A value which is initialized on the first access.
• StaticResource
  Static files resource.
• TypeId
  A TypeId represents a globally unique identifier for a type.

Type Aliases

• HashMapResources
• Weight

Attribute Macros

• fn_builder
• main
  Marks async main function as the PageTop entry-point.
• test
  Marks async test functions to use the PageTop entry-point.

Derive Macros

• AutoDefault
• ComponentClasses