Sociurl
INTERACTIVE WORKBENCH

Package playground

Explore the core API, React integration, registry, platform data, and errors.

15 built-ins
01

Core URL API

Try all four URL helpers on one input, with platform constraints and custom messages.

validateSocialUrl()valid
{
  "valid": true,
  "platform": "instagram",
  "username": "natgeo",
  "normalizedUrl": "https://www.instagram.com/natgeo",
  "error": null
}
Helper resultslive
detectPlatforminstagramextractUsernamenatgeonormalizeSocialUrlhttps://www.instagram.com/natgeo

getSupportedPlatforms() · getPlatformInfo(id)

02

Custom platform registry

Add, overwrite, look up, and remove platform definitions. The form supports path and query patterns.

has(id) false · get(id) null · getAll() 15 · findByHostname null
Custom registrations0

No custom platforms yet.

Register one, then try its URL above. Custom usernames use a sample alphanumeric rule.

03

SocialInput

Controlled input, platform restriction, message overrides, and validation callback.

showIcon=false keeps this app on React Icons.

onValidationChange result

null
Props you can explore
  • value / defaultValue and onChange
  • platform, registry, validateOn
  • onValidationChange and messages
  • showError, disabled, readOnly
  • container, label, field, error class/style props
validateOn="change" | "blur"
04

useSocialValidator

Check change and blur modes, manual validation, touched state, errors, and reset.

touched: false · valid: false
null
06

Platform definitions and icon data

Inspect all built-ins and the selected platform’s domains, patterns, reserved paths, and brand metadata.

Instagraminstagram

domains: instagram.com

canonical: www.instagram.com

brand color: #E4405F · icon data: 0 0 24 24, 1 paths

{
  "id": "instagram",
  "name": "Instagram",
  "domains": [
    "instagram.com"
  ],
  "allowedSubdomains": [
    "www",
    "m"
  ],
  "canonicalDomain": "www.instagram.com",
  "profilePatterns": [
    {
      "handle": "plain",
      "username": {
        "pattern": "/^(?!\\.)(?!.*\\.\\.)(?!.*\\.$)[A-Za-z0-9._]{1,30}$/",
        "minLength": 1,
        "maxLength": 30,
        "description": "Letters, numbers, periods and underscores; no trailing period."
      },
      "description": "Root profile path: /username"
    }
  ],
  "reservedPaths": [
    "about",
    "accounts",
    "api",
    "ar",
    "blog",
    "business",
    "challenge",
    "developer",
    "direct",
    "directory",
    "download",
    "emails",
    "explore",
    "graphql",
    "help",
    "invites",
    "legal",
    "lite",
    "locations",
    "login",
    "logout",
    "nametag",
    "oauth",
    "p",
    "press",
    "privacy",
    "reel",
    "reels",
    "s",
    "session",
    "stories",
    "terms",
    "test",
    "tv",
    "web",
    "your_activity"
  ],
  "icon": {
    "viewBox": "0 0 24 24",
    "paths": [
      "M7.0301.084c-1.2768.0602-2.1487.264-2.911.5634-.7888.3075-1.4575.72-2.1228 1.3877-.6652.6677-1.075 1.3368-1.3802 2.127-.2954.7638-.4956 1.6365-.552 2.914-.0564 1.2775-.0689 1.6882-.0626 4.947.0062 3.2586.0206 3.6671.0825 4.9473.061 1.2765.264 2.1482.5635 2.9107.308.7889.72 1.4573 1.388 2.1228.6679.6655 1.3365 1.0743 2.1285 1.38.7632.295 1.6361.4961 2.9134.552 1.2773.056 1.6884.069 4.9462.0627 3.2578-.0062 3.668-.0207 4.9478-.0814 1.28-.0607 2.147-.2652 2.9098-.5633.7889-.3086 1.4578-.72 2.1228-1.3881.665-.6682 1.0745-1.3378 1.3795-2.1284.2957-.7632.4966-1.636.552-2.9124.056-1.2809.0692-1.6898.063-4.948-.0063-3.2583-.021-3.6668-.0817-4.9465-.0607-1.2797-.264-2.1487-.5633-2.9117-.3084-.7889-.72-1.4568-1.3876-2.1228C21.2982 1.33 20.628.9208 19.8378.6165 19.074.321 18.2017.1197 16.9244.0645 15.6471.0093 15.236-.005 11.977.0014 8.718.0076 8.31.0215 7.0301.0839m.1402 21.6932c-1.17-.0509-1.8053-.2453-2.2287-.408-.5606-.216-.96-.4771-1.3819-.895-.422-.4178-.6811-.8186-.9-1.378-.1644-.4234-.3624-1.058-.4171-2.228-.0595-1.2645-.072-1.6442-.079-4.848-.007-3.2037.0053-3.583.0607-4.848.05-1.169.2456-1.805.408-2.2282.216-.5613.4762-.96.895-1.3816.4188-.4217.8184-.6814 1.3783-.9003.423-.1651 1.0575-.3614 2.227-.4171 1.2655-.06 1.6447-.072 4.848-.079 3.2033-.007 3.5835.005 4.8495.0608 1.169.0508 1.8053.2445 2.228.408.5608.216.96.4754 1.3816.895.4217.4194.6816.8176.9005 1.3787.1653.4217.3617 1.056.4169 2.2263.0602 1.2655.0739 1.645.0796 4.848.0058 3.203-.0055 3.5834-.061 4.848-.051 1.17-.245 1.8055-.408 2.2294-.216.5604-.4763.96-.8954 1.3814-.419.4215-.8181.6811-1.3783.9-.4224.1649-1.0577.3617-2.2262.4174-1.2656.0595-1.6448.072-4.8493.079-3.2045.007-3.5825-.006-4.848-.0608M16.953 5.5864A1.44 1.44 0 1 0 18.39 4.144a1.44 1.44 0 0 0-1.437 1.4424M5.8385 12.012c.0067 3.4032 2.7706 6.1557 6.173 6.1493 3.4026-.0065 6.157-2.7701 6.1506-6.1733-.0065-3.4032-2.771-6.1565-6.174-6.1498-3.403.0067-6.156 2.771-6.1496 6.1738M8 12.0077a4 4 0 1 1 4.008 3.9921A3.9996 3.9996 0 0 1 8 12.0077"
    ],
    "color": "#E4405F"
  }
}
Built-in platformsbuiltInPlatforms

The package SocialIcon API supports size, color, colorStyle, label, decorative, and registry. This playground uses React Icons for previews instead.

07

Validation errors

Inspect each error helper and use the message override in the Core API section.

{
  "code": "MISSING_USERNAME",
  "message": "Instagram username is missing"
}
createValidationError(code, message)invalidUrl()unsupportedPlatform()missingUsername(platform)invalidUsername(platform)invalidProfilePath(platform)invalidProtocol()