Aller au contenu
Accueil moxon

Placeholder

L'endpoint /placeholder génère des placeholders SVG : images simples ou squelettes de chargement animés.

gethttps://api.moxon.dev/v6/placeholder
Essayerget/v6/placeholder

Paramètres

  • type"image" | "skeleton"requis

    image ou skeleton

    —
  • widthnumberoptionnel

    Largeur en pixels (1–4000)

    Par défaut : 800.

  • heightnumberoptionnel

    Hauteur en pixels (1–4000)

    Par défaut : 600.

  • bgstringoptionnel

    Couleur de fond (hex)

    Par défaut : #cccccc / #e5e5e5.

  • colorstringoptionnel

    Couleur texte / highlight (hex)

    Par défaut : #333333 / #f5f5f5.

  • textstringoptionnel

    Texte affiché (image uniquement)

    Par défaut : 800×600.

  • rowsnumberoptionnel

    Nombre de lignes (skeleton uniquement, 0–20)

    Par défaut : 3.

  • avatarstringoptionnel

    Forme d'avatar : circle, rounded, square ou true

    —
    • true
    • circle
    • rounded
    • square
  • linesnumberoptionnel

    Lignes de texte à côté de l'avatar (skeleton)

    Par défaut : 2.

  • animate"shimmer" | "pulse" | "none"optionnel

    Animation : shimmer, pulse, none

    Par défaut : shimmer.

  • speednumberoptionnel

    Vitesse d'animation (0.1–10)

    Par défaut : 1.5.

  • radiusnumberoptionnel

    Border radius des blocs (0–50)

    Par défaut : 4.

À savoir

Les valeurs par défaut de bg et color diffèrent selon le type : image utilise #cccccc/#333333, skeleton utilise #e5e5e5/#f5f5f5.

Réponse

La réponse est un fichier image/svg+xml pour les deux types.

Exemples de code

Gestion des erreurs

Si les paramètres sont manquants ou invalides, l'API retournera une erreur :

  • 400Type must be one of: image, skeletonLe paramètre type est invalide
  • 400width must be a numberLa largeur n'est pas un nombre valide
  • 400width must be between 1 and 4000La largeur est hors limites
  • 400Invalid color (use hex like #ff6600)Un paramètre couleur est mal formaté
  • 400avatar must be one of: circle, rounded, squareForme d'avatar invalide
  • 400animate must be one of: shimmer, pulse, noneMode d'animation invalide
  • 400speed must be between 0.1 and 10La vitesse est hors limites
  • 400radius must be between 0 and 50Le radius est hors limites