# TraversableNode.Companion.TraverseDescendantsAction

Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/node/TraversableNode.kt+class:androidx.compose.ui.node.TraversableNode.Companion.TraverseDescendantsAction) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.6.0) Common/AllAndroid/JVM
- Cmn

  ```
  enum TraversableNode.Companion.TraverseDescendantsAction : Enum<TraversableNode.Companion.TraverseDescendantsAction>
  ```

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[TraversableNode.Companion.TraverseDescendantsAction](https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction)\> ||
|   | ↳ | [androidx.compose.ui.node.TraversableNode.Companion.TraverseDescendantsAction](https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction) |

*** ** * ** ***

Tree traversal actions for the traverseDescendantsIf related functions:

- Continue - continue the traversal

- SkipSubtreeAndContinue - continue the traversal BUT skip the matching node's subtree (this is a rarer case)

- CancelTraversal - cancels the traversal (returns from function call)

To see examples of all the actions, see TraversableModifierNodeTest. For a return/cancel example specifically, see traverseSubtreeWithSameKeyIf_cancelTraversalOfDifferentClassSameKey().

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction#CancelTraversal` |   |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction#ContinueTraversal` |   |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction#SkipSubtreeAndContinueTraversal` |   |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction#valueOf(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction#values()()` Returns an array containing the constants of this enum type, in the order they're declared. | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/node/TraversableNode.Companion.TraverseDescendantsAction#entries()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. | Cmn |

## Enum Values

### CancelTraversal

```
val TraversableNode.Companion.TraverseDescendantsAction.CancelTraversal: TraversableNode.Companion.TraverseDescendantsAction
```

### ContinueTraversal

```
val TraversableNode.Companion.TraverseDescendantsAction.ContinueTraversal: TraversableNode.Companion.TraverseDescendantsAction
```

### SkipSubtreeAndContinueTraversal

```
val TraversableNode.Companion.TraverseDescendantsAction.SkipSubtreeAndContinueTraversal: TraversableNode.Companion.TraverseDescendantsAction
```

## Public functions

### valueOf

Cmn Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.6.0)

```
fun valueOf(value: String): TraversableNode.Companion.TraverseDescendantsAction
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Cmn Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.6.0)

```
fun values(): Array<TraversableNode.Companion.TraverseDescendantsAction>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.

## Public properties

### entries

Cmn

```
val entries: EnumEntries<TraversableNode.Companion.TraverseDescendantsAction>
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.