url.md

Component URLs

A component URL is a URL that identifies a component.

This section describes the syntax used for displaying URLs to users.

URL Format

A component URL can, in principle, have any scheme. Some common schemes you may encounter are:

• fuchsia-pkg
• fuchsia-boot
• http(s)

fuchsia-pkg {#fuchsia-pkg}

A fuchsia-pkg component URL is a package URL that locates a component distributed in a Fuchsia package.

It has the same format as package URL, with a resource path relative to the package root that locates a component manifest. This path is usually of the form meta/<manifest_name>.cm.

fuchsia-pkg://<repo-hostname>[/<pkg-name>[/<pkg-variant>][?hash=<pkg-hash>][#<path-to-manifest>]]

Example:

fuchsia-pkg://fuchsia.com/stash#meta/stash_secure.cm

fuchsia-boot {#fuchsia-boot}

A fuchsia-boot component URL locates a component in the system boot image. This scheme is used to identify components that must be resolved during early boot before a fuchsia-pkg resolver is available. It has the following format:

fuchsia-boot:///<path-to-manifest-in-bootfs>

Example:

fuchsia-boot:///#meta/driver_manager.cm

http(s) {#http}

An http(s) component URL identifies a web page as a component. Such a component could be executed as a web page in a web runner, for example.

Example:

https://en.wikipedia.org/wiki/Hippos

Relative URLs {#relative}

The Component Framework supports a subset of relative URLs (Relative URLs are defined in URL RFC 3986). Specifically, Component Framework only supports relative URLs expressed as URL fragments. If a relative URL has any fields set other than the fragment then it will not resolve.

A relative URL resolved at runtime based on the URL of the parent component's package. Relative URLs have the following format:

#<path-to-manifest>

Example:

#meta/child.cm

For a fuchsia-pkg parent component with the following URL:

fuchsia-pkg://fuchsia.com/package#meta/component.cm

The relative URL resolves to:

fuchsia-pkg://fuchsia.com/package#meta/child.cm