Skip to main content

Documentation Index

Fetch the complete documentation index at: https://strapi-suite.littlebox.pt/llms.txt

Use this file to discover all available pages before exploring further.

Parameters allow you to configure your application dynamically without changing the code. In this framework, parameters are automatically fetched from the backend and made available globally to all your components.

​
How it works

The framework handles the data fetching for you. The ParameterProvider is already configured in your main layout, so you don’t need to worry about retrieving the data from the API manually. It automatically loads all public parameters created in the Strapi backend.
Check the backend documentation to learn how to create and manage parameters in the admin panel.

​
Accessing Parameters

To use a parameter in your component, you use the useParameter hook. This hook gives you access to the get function, which retrieves the value of a parameter by its unique identifier (UID).

​
Step 1: Import the hook

First, import the useParameter hook from the core context. 
import { useParameter } from "@/app/core/contexts/parameter";

​
Step 2: Retrieve the value

Call the hook inside your component to get the parameter instance. Then, usage the .get() method with the parameter’s UID to get its value. 
export default function WeatherWidget() {
  // Access the parameter context
  const parameter = useParameter();

  // Get values by their UID
  const latitude = parameter.get("support-lat");
  const longitude = parameter.get("support-long");

  return (
    <div>
      <p>Latitude: {latitude}</p>
      <p>Longitude: {longitude}</p>
    </div>
  );
}
The .get() method throws an error if the parameter with the specified UID does not exist. Ensure you use the correct UID defined in your backend.

​
Example

Here is how the Weather component uses parameters to fetch location-specific weather data: 
"use client";

import { useEffect, useState } from "react";
import { useParameter } from "@/app/core/contexts/parameter";
import { getWeather } from "@/app/components/detached/weather/actions";

export default function Weather() {
  const parameter = useParameter();
  // ... state definitions

  useEffect(() => {
    const fetch = async () => {
      // Retrieve coordinates dynamically
      const latitude = parameter.get("support-lat");
      const longitude = parameter.get("support-long");

      // Use values to fetch data
      const weather = await getWeather(latitude, longitude);
      // ... update state
    };
    fetch();
  }, []);

  return (
    // ... component JSX
  );
}