dnrops
/
tauri
mirror of https://github.com/tauri-apps/tauri
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(tauri): enhance Manager::add_capability documentation (#11206) 

* chore(tauri): enhance Manager::add_capability documentation

* enhance example

* add note on config
This commit is contained in:
Lucas Fernandes Nogueira 2024-10-03 08:36:36 -03:00 committed by GitHub
parent 0ab2b33064
commit 6f3a2b38f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
crates/tauri/src/lib.rs
View File

@ -766,6 +766,10 @@ pub trait Manager<R: Runtime>: sealed::ManagerBase<R> {
/// Adds a capability to the app.
///
/// Note that by default every capability file in the `src-tauri/capabilities` folder
/// are automatically enabled unless specific capabilities are configured in [`tauri.conf.json > app > security > capabilities`],
/// so you should use a different director for the runtime-added capabilities or use [tauri_build::Attributes::capabilities_path_pattern].
///
/// # Examples
/// ```
/// use tauri::Manager;
@ -773,10 +777,35 @@ pub trait Manager<R: Runtime>: sealed::ManagerBase<R> {
/// tauri::Builder::default()
/// .setup(|app| {
/// #[cfg(feature = "beta")]
/// app.add_capability(include_str!("../capabilities/beta.json"));
/// app.add_capability(include_str!("../capabilities/beta/cap.json"));
///
/// #[cfg(feature = "stable")]
/// app.add_capability(include_str!("../capabilities/stable/cap.json"));
/// Ok(())
/// });
/// ```
///
/// The above example assumes the following directory layout:
/// ```md
/// ├── capabilities
/// │ ├── app (default capabilities used by any app flavor)
/// | | |-- cap.json
/// │ ├── beta (capabilities only added to a `beta` flavor)
/// | | |-- cap.json
/// │ ├── stable (capabilities only added to a `stable` flavor)
/// | |-- cap.json
/// ```
///
/// For this layout to be properly parsed by Tauri, we need to change the build script to
///
/// ```skip
/// // only pick up capabilities in the capabilities/app folder by default
/// let attributes = tauri_build::Attributes::new().capabilities_path_pattern("./capabilities/app/*.json");
/// tauri_build::try_build(attributes).unwrap();
/// ```
///
/// [`tauri.conf.json > app > security > capabilities`]: https://tauri.app/reference/config/#capabilities
/// [tauri_build::Attributes::capabilities_path_pattern]: https://docs.rs/tauri-build/2/tauri_build/struct.Attributes.html#method.capabilities_path_pattern
fn add_capability(&self, capability: impl RuntimeCapability) -> Result<()> {
self
.manager()