@atlaskit/icon/offerings.json

An icon is a symbol representing a command, device, directory, or common action.

[
	{
		"name": "Icon",
		"package": "@atlaskit/icon",
		"import": {
			"name": "Icon",
			"package": "@atlaskit/icon",
			"type": "default"
		},
		"keywords": ["icon", "symbol", "command", "device", "directory", "action", "visual"],
		"categories": ["images-and-icons"],
		"shortDescription": "An icon is a symbol representing a command, device, directory, or common action.",
		"status": "general-availability",
		"accessibilityGuidelines": [
			"Provide appropriate alt text or labels for icons",
			"Use meaningful icon choices that convey clear meaning",
			"Ensure sufficient color contrast for icon visibility",
			"Consider icon size for touch targets",
			"Use consistent iconography across the interface"
		],
		"usageGuidelines": [
			"Use icons to enhance visual communication",
			"Choose icons that clearly represent their function",
			"Maintain consistent icon style and size",
			"Use appropriate icon sizes for different contexts",
			"Consider cultural and contextual icon meanings"
		],
		"contentGuidelines": [
			"Use clear, recognizable icon symbols",
			"Ensure icons are culturally appropriate",
			"Maintain visual consistency across icon sets",
			"Use appropriate icon labels and descriptions"
		],
		"generativeInstructions": "./docs/ai/icon-instructions.md",
		"examples": ["./examples/ai/icon.tsx"]
	},
	{
		"name": "IconTile",
		"package": "@atlaskit/icon",
		"import": {
			"name": "IconTile",
			"package": "@atlaskit/icon",
			"type": "named"
		},
		"keywords": ["icon", "tile", "container", "background", "shape", "appearance"],
		"categories": ["images-and-icons"],
		"shortDescription": "A tile component that displays an icon with customizable background, shape, and appearance.",
		"status": "release-candidate",
		"accessibilityGuidelines": [
			"Provide appropriate labels for icon tiles",
			"Ensure sufficient color contrast",
			"Use meaningful icon choices",
			"Consider touch target sizes"
		],
		"usageGuidelines": [
			"Use for icon presentation with background styling",
			"Choose appropriate shapes and appearances",
			"Maintain consistent sizing across tiles",
			"Use for visual emphasis or categorization"
		],
		"contentGuidelines": [
			"Use clear, recognizable icons",
			"Choose appropriate colors and shapes",
			"Ensure visual consistency across tiles"
		],
		"generativeInstructions": "./docs/ai/icon-tile-instructions.md",
		"examples": ["./examples/ai/icon-tile.tsx"]
	}
]