Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / embed

embed

Ethereum Comments Protocol SDK Embed Functionality for embedding comments in web applications

Components

FunctionDescription
CommentsByAuthorEmbedRenders comments embed iframe for the given author.
CommentsByChannelEmbedRenders comments embed iframe for a specific channel.
CommentsByRepliesEmbedRenders comments embed iframe for replies to a specific comment.
CommentsEmbedRenders comments embed iframe for the given uri.

Other

NameDescription
CommentsByAuthorEmbedProps-
CommentsByChannelEmbedProps-
CommentsByRepliesEmbedProps-
CommentsEmbedPropsThe props for <CommentsEmbed /> component.
CreateCommentsEmbedURLParamsParameters for createCommentsEmbedURL
EmbedConfigFontSchemaType-
EmbedConfigHotSortingSchemaType-
EmbedConfigReactionSchemaType-
EmbedConfigSchemaInputTypeCustom configuration for <CommentEmbed /> component.
EmbedConfigSchemaOutputType-
EmbedConfigSortingAlgorithmSchemaType-
EmbedConfigSortingSchemaType-
EmbedConfigSupportedChainIdsSchemaTypeThe type for supported chain ids
EmbedConfigThemeColorsSchemaType-
EmbedConfigThemeOtherSchemaType-
EmbedConfigThemePaletteSchemaType-
EmbedConfigThemeSchemaTypeThe type for embed theme configuration
EmbedGetDimensionsEventSchemaType-
EmbedResizedEventSchemaType-
EMBED_DEFAULT_REACTIONSFallback reaction when no custom reactions are configured.
EMBED_REACTION_ICON_PRESETS-
EMBED_REACTION_PRESETSBuilt-in reaction presets for iframe configurators.
EmbedConfigFontSchema-
EmbedConfigFontSizeSchema-
EmbedConfigHotSortingSchema-
EmbedConfigReactionSchema-
EmbedConfigReactionsSchema-
EmbedConfigSchemaThe zod schema for EmbedConfigSchemaType
EmbedConfigSortingAlgorithmSchema-
EmbedConfigSortingSchema-
EmbedConfigSupportedChainIdsSchemaThe zod schema for supported chain ids
EmbedConfigSupportedFontIt supports the following fonts from GoogleFonts
EmbedConfigThemeColorsSchema-
EmbedConfigThemeOtherSchema-
EmbedConfigThemePaletteSchema-
EmbedConfigThemeSchemaThe zod schema for embed theme configuration
EmbedGetDimensionsEventSchema-
EmbedResizedEventSchema-
createCommentsEmbedURLCreates a URL for the comments embed iframe.
parseCommentsEmbedConfigParse compressed config from config search param.