custom-elements.json

{
  "schemaVersion": "1.0.0",
  "readme": "",
  "modules": [
    {
      "kind": "javascript-module",
      "path": "src/github/repository/index.js",
      "declarations": [
        {
          "kind": "class",
          "description": "GitHub repository web component",
          "name": "GitHubRepository",
          "members": [
            {
              "kind": "field",
              "name": "attrs",
              "type": {
                "text": "object"
              },
              "default": "{}"
            },
            {
              "kind": "field",
              "name": "repo",
              "type": {
                "text": "object"
              },
              "default": "{}"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "repository org and name, as in `scottnath/profile-components`",
              "name": "full_name",
              "kind": "field"
            },
            {
              "type": {
                "text": "boolean"
              },
              "description": "when true, fetches repo from the [GitHub api](https://docs.github.com/en/rest/repos/repos#get-a-repository)",
              "name": "fetch",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "repo name",
              "name": "name",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "repo owner organization's login, found at `<REST_RESPONSE>.organization.login`",
              "name": "org",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "repo description",
              "name": "description",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "programming language used in repo",
              "name": "language",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "number of stars",
              "name": "stargazers_count",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "number of forks",
              "name": "forks_count",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "number of watchers",
              "name": "subscribers_count",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "Itemprop content to go with a containing component's itemscope",
              "name": "itemprop",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "Do not include the repo owner or organization",
              "name": "no_org",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "color theme for the component",
              "name": "theme",
              "kind": "field"
            }
          ],
          "superclass": {
            "name": "HTMLElement"
          },
          "tagName": "github-repository",
          "summary": "Native web component which shows a GitHub repository's content. Can use local data, \nfetch data from the GitHub rest API, or use a combination of both.",
          "customElement": true
        }
      ],
      "exports": [
        {
          "kind": "js",
          "name": "GitHubRepository",
          "declaration": {
            "name": "GitHubRepository",
            "module": "src/github/repository/index.js"
          }
        },
        {
          "kind": "custom-element-definition",
          "name": "github-repository",
          "declaration": {
            "name": "GitHubRepository",
            "module": "src/github/repository/index.js"
          }
        }
      ]
    },
    {
      "kind": "javascript-module",
      "path": "src/github/user/index.js",
      "declarations": [
        {
          "kind": "class",
          "description": "GitHub user profile web component",
          "name": "GitHubUser",
          "members": [
            {
              "kind": "field",
              "name": "attrs",
              "type": {
                "text": "object"
              },
              "default": "{}"
            },
            {
              "kind": "field",
              "name": "content",
              "type": {
                "text": "object"
              },
              "default": "{}"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "User's GitHub login",
              "name": "login",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "URL to user's avatar",
              "name": "avatar_url",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "User's name",
              "name": "name",
              "kind": "field"
            },
            {
              "type": {
                "text": "boolean"
              },
              "description": "when true, fetches user from the [GitHub api](https://docs.github.com/en/rest/users/users#get-a-user)",
              "name": "fetch",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "alias for `login`",
              "name": "username",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "User's biography content",
              "name": "bio",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "number of people user is following",
              "name": "following",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "number of followers",
              "name": "followers",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "JSON stringified array of repositories",
              "name": "repos",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "color theme for the component",
              "name": "theme",
              "kind": "field"
            }
          ],
          "superclass": {
            "name": "HTMLElement"
          },
          "tagName": "github-user",
          "summary": "Native web component which shows a GitHub user's profile content. Can use local data, \nfetch data from the GitHub rest API, or use a combination of both.",
          "customElement": true
        }
      ],
      "exports": [
        {
          "kind": "js",
          "name": "GitHubUser",
          "declaration": {
            "name": "GitHubUser",
            "module": "src/github/user/index.js"
          }
        },
        {
          "kind": "custom-element-definition",
          "name": "github-user",
          "declaration": {
            "name": "GitHubUser",
            "module": "src/github/user/index.js"
          }
        }
      ]
    },
    {
      "kind": "javascript-module",
      "path": "src/devto/user/index.js",
      "declarations": [
        {
          "kind": "class",
          "description": "dev.to user profile web component",
          "name": "DevtoUser",
          "members": [
            {
              "kind": "field",
              "name": "attrs",
              "type": {
                "text": "object"
              },
              "default": "{}"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "User's dev.to username",
              "name": "username",
              "kind": "field"
            },
            {
              "type": {
                "text": "boolean"
              },
              "description": "when true, fetches user and posts from the [Forem API](https://developers.forem.com/api/v0#tag/users/operation/getUser)",
              "name": "fetch",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "The name of the user",
              "name": "name",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "The user's bio",
              "name": "summary",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "The date the user joined",
              "name": "joined_at",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "The URL of the user's profile image",
              "name": "profile_image",
              "kind": "field"
            },
            {
              "type": {
                "text": "number"
              },
              "description": "The number of posts the user has published",
              "name": "post_count",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "User's latest post content, JSON stringified",
              "name": "latest_post",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "User's most popular post content, JSON stringified",
              "name": "popular_post",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "color theme for the component",
              "name": "theme",
              "kind": "field"
            }
          ],
          "superclass": {
            "name": "HTMLElement"
          },
          "tagName": "devto-user",
          "summary": "Native web component which shows a dev.to user's profile content. \nCan use local data, or fetch data from the dev.to API, or use a combination of both.",
          "customElement": true
        }
      ],
      "exports": [
        {
          "kind": "js",
          "name": "DevtoUser",
          "declaration": {
            "name": "DevtoUser",
            "module": "src/devto/user/index.js"
          }
        },
        {
          "kind": "custom-element-definition",
          "name": "devto-user",
          "declaration": {
            "name": "DevtoUser",
            "module": "src/devto/user/index.js"
          }
        }
      ]
    },
    {
      "kind": "javascript-module",
      "path": "src/devto/post/index.js",
      "declarations": [
        {
          "kind": "class",
          "description": "dev.to post web component",
          "name": "DevtoPost",
          "members": [
            {
              "kind": "field",
              "name": "attrs",
              "type": {
                "text": "object"
              },
              "default": "{}"
            },
            {
              "type": {
                "text": "number"
              },
              "description": "Post ID",
              "name": "id",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "Post title",
              "name": "title",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "Post URL",
              "name": "url",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "Post cover image URL",
              "name": "cover_image",
              "kind": "field"
            },
            {
              "type": {
                "text": "string"
              },
              "description": "Post social image URL",
              "name": "social_image",
              "kind": "field"
            },
            {
              "type": {
                "text": "boolean"
              },
              "description": "when true, fetches post from the [Forem API](https://developers.forem.com/api/v0#tag/articles/operation/getArticleById)",
              "name": "fetch",
              "kind": "field"
            }
          ],
          "superclass": {
            "name": "HTMLElement"
          },
          "tagName": "devto-post",
          "summary": "Native web component which shows a dev.to (or forem.dev) post. Can use local data,\nfetch data from the dev.to API, or use a combination of both.",
          "customElement": true
        }
      ],
      "exports": [
        {
          "kind": "js",
          "name": "DevtoPost",
          "declaration": {
            "name": "DevtoPost",
            "module": "src/devto/post/index.js"
          }
        },
        {
          "kind": "custom-element-definition",
          "name": "devto-post",
          "declaration": {
            "name": "DevtoPost",
            "module": "src/devto/post/index.js"
          }
        }
      ]
    }
  ]
}