Skip to content

Expanded component examples index #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 26 additions & 1 deletion docs/building-extensions/components/component-examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,29 @@ title: Example Components
Component Examples
==================

In this section you can find worked examples of components of various types.
This section contains worked examples of components of various types. To obtain the examples source code to inspect or install you may clone the manual-examples repository or download an installable zip file for an individual example.

## To clone the repository

Navigate to a location on your development computer where you can keep multiple repositories. You might have a folder named `repos` or `git` or something else. In a terminal window use the following command:

```sh
git clone https://github.com/joomla/manual-examples.git
```

This takes no time at all and will give you a clone of the manual-examples repository that is very easy to inspect in an IDE. Here is an example screenshot of a clone open in VSCode:

![screenshot of manual examples folder in vscode](_assets/manual-examples-in-vscode.png)

To create an installable zip file, compress the subfolder containing the example code, such as the com_exampleform folder.

## To download an installable zip

1. Go to the [manual-examples repository](https://github.com/joomla/manual-examples) on GitHub.
2. Select the example you wish to download, for example component-exampleform.
3. Select the subfolder containing the example, com_exampleform.
4. Copy the URL from the browser URL bar.
5. Go to a download utility site such as [DownGit](https://downgit.github.io/#/home).
6. Paste the URL copied in step 4 into the form.
7. Select the Download button.
8. Save the downloaded zip file. This can be installed in a Joomla instance or expanded to inspect with an IDE.