fetcher.md

Fetcher

Translations: 简体中文

Fetcher is used to get data from uri, return FetchResult, and hand it over to Decoder for use.

Each uri supported by Sketch has a corresponding Fetcher implementation, as shown in the following table:

URI	Fetcher	Create	Dependent modules	Android	iOS	Desktop	Web
http://, https://	HurlHttpUriFetcher	-	sketch-http-hurl	✅	❌	✅	❌
http://, https://	OkHttpHttpUriFetcher	-	sketch-http-okhttp	✅	❌	✅	❌
http://, https://	KtorHttpUriFetcher	-	sketch-http-ktor3	✅	✅	✅	✅
file://, /	FileUriFetcher	newFileUri()	-	✅	✅	✅	✅
file:///compose_resource/	ComposeResourceUriFetcher	newComposeResourceUri()	sketch-compose-resources	✅	✅	✅	✅
data:image/, data:img/	Base64UriFetcher	newBase64Uri()	-	✅	✅	✅	✅
file:///android_asset/	AssetUriFetcher	newAssetUri()	-	✅	❌	❌	❌
content://	ContentUriFetcher	-	-	✅	❌	❌	❌
android.resource://	ResourceUriFetcher	newResourceUri()	-	✅	❌	❌	❌
app.icon://	AppIconUriFetcher	newAppIconUri()	sketch-extensions-appicon	✅	❌	❌	❌
file:///kotlin_resource/	KotlinResourceUriFetcher	newKotlinResourceUri()	-	❌	✅	✅	❌

• HurlHttpUriFetcher: Use the HttpURLConnection that comes with jvm to load images from the network. Learn more
• OkHttpHttpUriFetcher: Use OkHttp to load images from the network. Learn more
• KtorHttpUriFetcher: Use Ktor to load images from the network. Learn more
• AssetUriFetcher: is used to load images from the Android assets directory
• ContentUriFetcher: ContentResolver for Android to load images
• ResourceUriFetcher: is used to load images from Android's resources directory
• AppIconUriFetcher: is used to load the icon of the installed App. It also needs to rely on sketch-extensions-core module. Learn more
• Base64UriFetcher: is used to load images from the base64 data block of the uri itself
• ComposeResourceUriFetcher: is used to load images from the composeResources directory of Compose Multiplatform, it also needs to depend on the sketch-compose-resources module.
• KotlinResourceUriFetcher: is used to load images from the resources directory of kotlin

Important

The above components all support automatic registration. You only need to import them without additional configuration. If you need to register manually, please read the documentation: 《Register component》

Extend Fetcher

First implement the Fetcher interface to define your Fetcher and its Factory

Then refer to the document 《Register component》 to register your Fetcher